speedruncom.js 1.3.0 → 2.0.0

package/src/endpoints/endpoints.get.ts

@@ -1,673 +1,653 @@
-//Endpoints that don't give the "Method Not Allowed" error when called with GET.
+//Endpoints that don't 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';
+import * as Enums from '../enums';
+import * as Interfaces from '../interfaces';
 
-/**
- * Gets a leaderboard, with Players included.
- * 
- * `GetGameLeaderboard` can fetch twice as many runs, and also fetches Games, Platforms, Regions, Values, and Variables.
- */
-export interface GetGameLeaderboard2 {
+export default interface GETEndpoints {
 
     /**
-     * The leaderboard to fetch.
-     */
-    params: Interfaces.LeaderboardParams;
-
-    /**
-     * The maximum amount of `Run`s per page.
+     * Gets a leaderboard, with Players included.
      * 
-     * @max 100
-     * @default 100
+     * `GetGameLeaderboard` can fetch twice as many runs, and also fetches Games, Platforms, Regions, Values, and Variables.
      */
-    limit?: number;
+    GetGameLeaderboard2: {
 
-    /**
-     * The leaderboard page, in relation to `limit`.
-     */
-    page?: number;
-
-}
+        /**
+         * The leaderboard to fetch.
+         */
+        params: Interfaces.LeaderboardParams;
 
-/**
- * Gets a leaderboard, with all relevant items included.
- * 
- * `GetGameLeaderboard2` only includes Runs and Players, and has half the maximum `limit`.
- */
-export interface GetGameLeaderboard {
+        /**
+         * The maximum amount of `Run`s per page.
+         * 
+         * @max 100
+         * @default 100
+         */
+        limit?: number;
 
-    /**
-     * The leaderboard to fetch.
-     */
-    params: Interfaces.LeaderboardParams;
+        /**
+         * The leaderboard page, in relation to `limit`.
+         */
+        page?: number;
+    };
 
     /**
-     * The limit of Runs per page.
-     * 
-     * @max 200
-     * @default 100
+     * Gets a specific site article.
      */
-    limit?: number;
+    GetArticle: {
 
-    /**
-     * The leaderboard page, in relation to `limit`.
-     */
-    page?: number;
-}
+        /**
+         * ID of the article to fetch.
+         */
+        id: string;
+    } | {
 
-/**
- * Gets mostly leaderboard-related data of a game.
- * 
- * Both parameters function the same. If both are included, `gameId` will override.
- */
-interface GetGameData_Base {
+        /**
+         * Slug of the article to fetch.
+         */
+        slug: string;
+    };
 
     /**
-     * ID of the game.
+     * Gets a leaderboard, with all relevant items included.
+     * 
+     * `GetGameLeaderboard2` only includes Runs and Players, and has half the maximum `limit`.
+     */
+    GetGameLeaderboard: {
+
+        /**
+         * The leaderboard to fetch.
+         */
+        params: Interfaces.LeaderboardParams;
+
+        /**
+         * The limit of Runs per page.
+         * 
+         * @max 200
+         * @default 100
+         */
+        limit?: number;
+
+        /**
+         * The leaderboard page, in relation to `limit`.
+         */
+        page?: number;
+    };
+
+    /**
+     * Gets the world record history of a game leaderboard.
+     */
+    GetGameRecordHistory: {
+
+        /**
+         * Leaderboard to fetch record history of.
+         */
+        params?: Interfaces.LeaderboardParams;
+
+        /**
+         * The limit of Runs per page.
+         * 
+         * @max 200
+         * @default 100
+         */
+        limit?: number;
+
+        /**
+         * The leaderboard page, in relation to `limit`.
+         */
+        page?: number;
+    };
+
+    /**
+     * Searches for site items with a query.
+     */
+    GetSearch: {
+
+        /**
+         * The text you are searching.
+         */
+        query?: string;
+
+        /**
+         * Useless parameter, there is no affect on what is fetched based on the value.
+         */
+        favorExactMatches?: boolean;
+
+        /**
+         * Whether or not you are searching for games.
+         */
+        includeGames?: boolean;
+
+        /**
+         * Whether or not you are searching for news.
+         */
+        includeNews?: boolean;
+
+        /**
+         * Whether or not you are searching for pages.
+         */
+        includePages?: boolean;
+
+        /**
+         * Whether or not you are searching for series.
+         */
+        includeSeries?: boolean;
+
+        /**
+         * Whether or not you are searching for users.
+         */
+        includeUsers?: boolean;
+
+        /**
+         * Whether or not you are searching for challenges.
+         */
+        includeChallenges?: boolean;
+
+        /**
+         * The maximum amount of items to fetch in each `[item]List` array.
+         * 
+         * @max 100
+         * @default 100
+         */
+        limit?: number;
+
+        /**
+         * The leaderboard page, in relation to `limit`.
+         */
+        page?: number;
+    };
+
+    /**
+     * Gets non-obsolete latest runs of a game.
+     * 
+     * When `seriesId` and `gameId` are exempted, 
      */
-    gameId: string;
+    GetLatestLeaderboard: {
 
-    /**
-     * Game page URL.
-     */
-    gameUrl: string;
-}
+        /**
+         * ID of the game.
+         * 
+         * When exempted, lists in the responses will be empty.
+         */
+        gameId?: string;
 
-export type GetGameData = AtLeastOne<GetGameData_Base, 'gameId' | 'gameUrl'>;
+        /**
+         * ID of a series
+         */
+        seriesId?: string;
 
-/**
- * Gets mostly miscellaneous data of a game.
- * 
- * Both parameters function the same. If both are included, `gameId` will override.
- */
-interface GetGameSummary_Base {
+        /**
+         * The maximum amount of Runs to fetch.
+         * 
+         * Warning: Obsolete runs are not included, but still count to the limit.
+         * 
+         * If this is `20` and 5 out of the 20 latest runs are obsolete, it will only return the 15 non-obsolete runs.
+         * 
+         * @max Around 99999, however it varies with caching-related factors.
+         * @default 25
+         */
+        limit?: number;
 
-    /**
-     * ID of the game.
-     */
-    gameId: string;
+        /**
+         * The run list page, in relation to `limit`.
+         */
+        page?: number;
+    };
 
     /**
-     * Subpath URL of the game.
+     * Gets a single run.
      */
-    gameUrl: string;
-}
-
-export type GetGameSummary = AtLeastOne<GetGameSummary_Base, 'gameId' | 'gameUrl'>;
+    GetRun: {
 
-/**
- * Gets the world record history of a game leaderboard.
- */
-export interface GetGameRecordHistory {
+        /**
+         * ID of the run.
+         */
+        runId: string;
+    };
 
     /**
-     * Leaderboard to fetch record history of.
+     * Gets non-run related data of a user.
      */
-    params?: Interfaces.LeaderboardParams;
+    GetUserSummary: {
 
-    /**
-     * The limit of Runs per page.
-     * 
-     * @max 200
-     * @default 100
-     */
-    limit?: number;
+        /**
+         * Subpath URL of the user.
+         */
+        url: string;
+    };
 
     /**
-     * The leaderboard page, in relation to `limit`.
+     * Gets comments posted by a user.
      */
-    page?: number;
-}
+    GetUserComments: {
 
-/**
- * Searches for site items with a query.
- */
-export interface GetSearch {
+        /**
+         * ID of the user.
+         */
+        userId: string;
+    };
 
     /**
-     * The text you are searching.
+     * Gets threads created by a specific user.
      */
-    query?: string;
+    GetUserThreads: {
 
-    /**
-     * Useless parameter, there is no affect on what is fetched based on the value.
-     */
-    favorExactMatches?: boolean;
-
-    /**
-     * Whether or not you are searching for games.
-     */
-    includeGames?: boolean;
+        /**
+         * ID of the user.
+         */
+        userId: string;
+    };
 
     /**
-     * Whether or not you are searching for news.
+     * Gets data for user popovers (when you hover over a username).
      */
-    includeNews?: boolean;
+    GetUserPopoverData: {
 
-    /**
-     * Whether or not you are searching for pages.
-     */
-    includePages?: boolean;
+        /**
+         * ID of the user.
+         */
+        userId: string;
+    };
 
     /**
-     * Whether or not you are searching for series.
+     * Gets all Titles in the site.
      */
-    includeSeries?: boolean;
+    GetTitleList: {};
 
     /**
-     * Whether or not you are searching for users.
+     * Gets a specific Title.
      */
-    includeUsers?: boolean;
+    GetTitle: {
 
-    /**
-     * Whether or not you are searching for challenges.
-     */
-    includeChallenges?: boolean;
+        /**
+         * ID of the title.
+         */
+        titleId: string;
+    };
 
     /**
-     * The maximum amount of items to fetch in each `[item]List` array.
-     * 
-     * @max 100
-     * @default 100
+     * Gets site articles.
      */
-    limit?: number;
+    GetArticleList: {
 
-    /**
-     * The leaderboard page, in relation to `limit`.
-     */
-    page?: number;
-}
+        /**
+         * Whether or not the article is published (verified by admin).
+         */
+        published?: boolean;
 
-/**
- * Gets non-obsolete latest runs of a game.
- * 
- * When `seriesId` and `gameId` are exempted, 
- */
-export interface GetLatestLeaderboard {
+        /**
+         * Whether or not the article is rejected.
+         */
+        rejected?: boolean;
 
-    /**
-     * ID of the game.
-     * 
-     * When exempted, lists in the responses will be empty.
-     */
-    gameId?: string;
+        /**
+         * A query to search for articles.
+         */
+        search?: string;
 
-    /**
-     * ID of a series
-     */
-    seriesId?: string;
+        /**
+         * Tags an article has.
+         */
+        tags?: string[];
 
-    /**
-     * The maximum amount of Runs to fetch.
-     * 
-     * Warning: Obsolete runs are not included, but still count to the limit.
-     * 
-     * If this is `20` and 5 out of the 20 latest runs are obsolete, it will only return the 15 non-obsolete runs.
-     * 
-     * @max Around 99999, however it varies with caching-related factors.
-     * @default 25
-     */
-    limit?: number;
+        /**
+         * The target of an article, either being `news` or a path URL for site information articles.
+         */
+        target?: string;
 
-    /**
-     * The run list page, in relation to `limit`.
-     */
-    page?: number;
-}
+        /**
+         * The maximum amount of Articles to fetch.
+         * 
+         * @max 500
+         * @default 500
+         */
+        limit?: number;
 
-/**
- * Gets a single run.
- */
-export interface GetRun {
+        /**
+         * The article list page, in relation to `limit`.
+         */
+        page?: number;
+    };
 
     /**
-     * ID of the run.
+     * Gets a list of games.
      */
-    runId: string;
-}
+    GetGameList: {
 
-/**
- * Gets non-run related data of a user.
- */
-export interface GetUserSummary {
+        /**
+         * ID of a series to filter by.
+         */
+        seriesId?: string;
 
-    /**
-     * Subpath URL of the user.
-     */
-    url: string;
-}
+        /**
+         * ID of a platform to filter by.
+         */
+        platformId?: string;
 
-/**
- * Gets comments posted by a user.
- */
-export interface GetUserComments {
+        /**
+         * Search query for game names or game subpath URLs.
+         */
+        search?: string;
 
-    /**
-     * ID of the user.
-     */
-    userId: string;
-}
-
-/**
- * Gets threads created by a specific user.
- */
-export interface GetUserThreads {
+        /**
+         * `GameOrderType` to filter games by.
+         */
+        orderType?: Enums.GameOrderType;
 
-    /**
-     * ID of the user.
-     */
-    userId: string;
-}
+        /**
+         * The maximum amount of Games to fetch.
+         * 
+         * @max 500
+         * @default 500
+         */
+        limit?: number;
 
-/**
- * Gets data for user popovers (when you hover over a username).
- */
-export interface GetUserPopoverData {
+        /**
+         * The game list page, in relation to `limit`.
+         */
+        page?: number;
+    };
 
     /**
-     * ID of the user.
+     * Gets a list of Platforms in the site.
      */
-    userId: string;
-}
-
-/**
- * Gets all Titles in the site.
- */
-export interface GetTitleList {}
-
-/**
- * Gets a specific Title.
- */
-export interface GetTitle {
+    GetPlatformList: {};
 
     /**
-     * ID of the title.
+     * Gets information for the home page.
      */
-    titleId: string;
-}
-
-/**
- * Gets site articles.
- */
-export interface GetArticleList {
+    GetHomeSummary: {};
 
     /**
-     * Whether or not the article is published (verified by admin).
+     * Gets a list of series on the site.
      */
-    published?: boolean;
+    GetSeriesList: {
 
-    /**
-     * Whether or not the article is rejected.
-     */
-    rejected?: boolean;
+        /**
+         * A query to search for, of series names or subpath URLs.
+         */
+        search?: string;
 
-    /**
-     * A query to search for articles.
-     */
-    search?: string;
-
-    /**
-     * Tags an article has.
-     */
-    tags?: string[];
+        /**
+         * `GameOrderType` to filter series by.
+         */
+        orderType?: Enums.GameOrderType;
 
-    /**
-     * The target of an article, either being `news` or a path URL for site information articles.
-     */
-    target?: string;
+        /**
+         * The maximum amount of Series to fetch.
+         * 
+         * @max 500
+         * @default 500
+         */
+        limit?: number;
 
-    /**
-     * The maximum amount of Articles to fetch.
-     * 
-     * @max 500
-     * @default 500
-     */
-    limit?: number;
+        /**
+         * The leaderboard page, in relation to `limit`.
+         */
+        page?: number;
+    };
 
     /**
-     * The article list page, in relation to `limit`.
+     * Gets most information pertinent to a series.
      */
-    page?: number;
-}
+    GetSeriesSummary: {
 
-/**
- * Gets a specific site article.
- */
-interface GetArticle_Base {
+        /**
+         * Subpath URL of the series.
+         */
+        seriesUrl: string;
+    };
 
     /**
-     * ID of the article to fetch.
+     * Gets the top 3 runs from all levels under a level category.
      */
-    id: string;
+    GetGameLevelSummary: {
 
-    /**
-     * Slug of the article to fetch.
-     */
-    slug: string;
-}
+        /**
+         * The game leaderboard to fetch level summaries from.
+         * 
+         * When not included, `runList[]` will be empty.
+         */
+        params?: Interfaces.LeaderboardParams;
 
-export type GetArticle = AtLeastOne<GetArticle_Base>;
+        /**
+         * The limit of Runs per page.
+         * 
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
 
-/**
- * Gets a list of games.
- */
-export interface GetGameList {
+        /**
+         * The leaderboard page, in relation to `limit`.
+         */
+        page?: number;
+    };
 
     /**
-     * ID of a series to filter by.
+     * Gets a random Game.
      */
-    seriesId?: string;
+    GetGameRandom: {};
 
     /**
-     * ID of a platform to filter by.
+     * Gets all guides on a game.
      */
-    platformId?: string;
+    GetGuideList: {
 
-    /**
-     * Search query for game names or game subpath URLs.
-     */
-    search?: string;
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+    };
 
     /**
-     * `GameOrderType` to filter games by.
+     * Get a specific guide.
      */
-    orderType?: Enums.GameOrderType;
+    GetGuide: {
 
-    /**
-     * The maximum amount of Games to fetch.
-     * 
-     * @max 500
-     * @default 500
-     */
-    limit?: number;
+        /**
+         * ID of the guide.
+         */
+        id: string;
+    };
 
     /**
-     * The game list page, in relation to `limit`.
+     * Gets news posts in a game.
      */
-    page?: number;
-}
-
-/**
- * Gets a list of Platforms in the site.
- */
+    GetNewsList: {
 
-export interface GetPlatformList {}
-
-/**
- * Gets information for the home page.
- */
-export interface GetHomeSummary {}
-
-/**
- * Gets a list of series on the site.
- */
-export interface GetSeriesList {
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+    };
 
     /**
-     * A query to search for, of series names or subpath URLs.
+     * Gets a specific game news post.
      */
-    search?: string;
-    orderType?: Enums.GameOrderType;
+    GetNews: {
 
-    /**
-     * The maximum amount of Series to fetch.
-     * 
-     * @max 500
-     * @default 500
-     */
-    limit?: number;
+        /**
+         * ID of the news post.
+         */
+        id: string;
+    };
 
     /**
-     * The leaderboard page, in relation to `limit`.
+     * Gets a single resource.
      */
-    page?: number;
-}
+    GetResource: {
 
-/**
- * Gets most information pertinent to a series.
- */
-export interface GetSeriesSummary {
+        /**
+         * ID of the resource.
+         */
+        resourceId: string;
+    };
 
     /**
-     * Subpath URL of the series.
+     * Get a list of a game's resources.
      */
-    seriesUrl: string;
-}
+    GetResourceList: {
 
-/**
- * Gets the top 3 runs from all levels under a level category.
- */
-export interface GetGameLevelSummary {
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+    };
 
     /**
-     * The game leaderboard to fetch level summaries from.
+     * Gets a list of live streams on twitch that have the `Speedrun` tag.
      * 
-     * When not included, `runList[]` will be empty.
+     * A stream is assigned to a game when the Twitch game is the Game's `GameSettings.twitchName`.
      */
-    params?: Interfaces.LeaderboardParams;
+    GetStreamList: {
 
-    /**
-     * The limit of Runs per page.
-     * 
-     * @max Unknown - likely around 99999.
-     * @default Unknown - likely around 99999.
-     */
-    limit?: number;
+        /**
+         * ID of a series.
+         */
+        seriesId?: string;
 
-    /**
-     * The leaderboard page, in relation to `limit`.
-     */
-    page?: number;
-}
-
-/**
- * Gets a random Game.
- */
-export interface GetGameRandom {}
-
-/**
- * Gets all guides on a game.
- */
-export interface GetGuideList {
+        /**
+         * ID of a game.
+         */
+        gameId?: string;
+    };
 
     /**
-     * ID of the game.
+     * Get threads on a forum.
      */
-    gameId: string;
-}
+    GetThreadList: {
 
-/**
- * Get a specific guide.
- */
-export interface GetGuide {  
+        /**
+         * ID of the forum.
+         */
+        forumId: string;
+    };
 
     /**
-     * ID of the guide.
+     * Gets a comment post's Thread and Forum by `commentId`.
      */
-    id: string;
-}
+    GetThreadStateByCommentId: {
 
-/**
- * Gets news posts in a game.
- */
-export interface GetNewsList {
+        /**
+         * ID of the comment.
+         */
+        commentId: string;
+    };
 
     /**
-     * ID of the game.
+     * Get a specific Challenge.
      */
-    gameId: string;
-}
+    GetChallenge: {
 
-/**
- * Gets a specific game news post.
- */
-export interface GetNews {
-    
-    /**
-     * ID of the news post.
-     */
-    id: string;
-}
-
-/**
- * Gets a single resource.
- */
-export interface GetResource {
-    resourceId: string;
-}
-
-/**
- * Get a list of a game's resources.
- */
-export interface GetResourceList {
-    gameId: string;
-}
-
-/**
- * Gets a list of live streams on twitch that have the `Speedrun` tag.
- * 
- * A stream is assigned to a game when the Twitch game is the Game's `GameSettings.twitchName`.
- */
-export interface GetStreamList {
-
-    /**
-     * ID of a series.
-     */
-    seriesId?: string;
+        /**
+         * ID of the challenge.
+         */
+        id: string;
+    };
 
     /**
-     * ID of a game.
+     * Get runs from a Challenge board.
      */
-    gameId?: string;
-}
+    GetChallengeLeaderboard: {
 
-/**
- * Get threads on a forum.
- */
-export interface GetThreadList {
+        /**
+         * ID of the challenge you are getting the leaderboard from.
+         */
+        challengeId: string;
+    };
 
     /**
-     * ID of the forum.
+     * Get a sitewide leaderboard for users who have won the most in Challenges.
      */
-    forumId: string;
-}
-
-/**
- * Gets a comment post's Thread and Forum by `commentId`.
- */
-export interface GetThreadStateByCommentId {
+    GetChallengeGlobalRankingList: {};
 
     /**
-     * ID of the comment.
+     * Get a specific Challenge run (not the same as a normal run!)
      */
-    commentId: string;
-}
+    GetChallengeRun: {
 
-/**
- * Get a specific Challenge.
- */
-export interface GetChallenge {
-    id: string;
-}
-
-/**
- * Get runs from a Challenge board.
- */
-export interface GetChallengeLeaderboard {
+        /**
+         * ID of the challenge.
+         */
+        id: string;
+    };
 
     /**
-     * ID of the challenge you are getting the leaderboard from.
+     * Get a user's runs for display on their profile.
      */
-    challengeId: string;
-}
-
-/**
- * Get a sitewide leaderboard for users who have won the most in Challenges.
- */
-export interface GetChallengeGlobalRankingList {}
+    GetUserLeaderboard: {
 
-/**
- * Get a specific Challenge run (not the same as a normal run!)
- */
-export interface GetChallengeRun {
+        /**
+         * ID of the user.
+         */
+        userId: string;
+    };
 
     /**
-     * ID of the challenge.
+     * Gets game and series moderation stats for any user.
      */
-    id: string;
-}
+    GetUserModeration: {
 
-/**
- * Get a user's runs for display on their profile.
- */
-export interface GetUserLeaderboard {
+        /**
+         * ID of the user.
+         */
+        userId: string;
+    };
 
     /**
-     * ID of the user.
+     * Get a list of comments on an item, and data of the parent.
      */
-    userId: string;
-}
+    GetCommentList: {
 
-/**
- * Gets game and series moderation stats for any user.
- */
-export interface GetUserModeration {
+        /**
+         * ID of the parent item to fetch.
+         */
+        itemId: string;
 
-    /**
-     * ID of the user.
-     */
-    userId: string;
-}
+        /**
+         * `ItemType` of the item referenced in `itemId`.
+         */
+        itemType: Enums.ItemType;
 
-/**
- * Get a list of comments on an item, and data of the parent.
- */
-export interface GetCommentList {
+        /**
+         * The maximum amount of `Comment`s per page.
+         * 
+         * When this is >= 500 but <= 1000, it will fetch a maximum of 500 `Run`s, but when over 1000 it will return a maximum of 20 runs.
+         * @max 500
+         * @default 20
+         */
+        limit?: number;
 
-    /**
-     * ID of the parent item to fetch.
-     */
-    itemId: string;
+        /**
+         * The comment page, in relation to `limit`.
+         */
+        page?: number;
+    };
 
     /**
-     * `ItemType` of the item referenced in `itemId`.
+     * Get a specific thread.
      */
-    itemType: Enums.ItemType;
+    GetThread: {
+
+        /**
+         * ID of the thread.
+         */
+        id: string;
+    };
 
     /**
-     * The maximum amount of `Comment`s per page.
-     * 
-     * When this is >= 500 but <= 1000, it will fetch a maximum of 500 `Run`s, but when over 1000 it will return a maximum of 20 runs.
-     * @max 500
-     * @default 20
+     * Get static data for the site.
      */
-    limit?: number;
+    GetStaticData: {};
 
     /**
-     * The comment page, in relation to `limit`.
+     * Get a list of site-wide forums. When logged in, may include forums of followed games.
      */
-    page?: number;
-}
-
-/**
- * Get a specific thread.
- */
-export interface GetThread {
+    GetForumList: {};
 
     /**
-     * ID of the thread.
+     * Gets the latest announcement, if there is one active.
      */
-    id: string;
-}
-
-/**
- * Get static data for the site.
- */
-export interface GetStaticData {}
-
-/**
- * Get a list of site-wide forums. When logged in, may include forums of followed games.
- */
-export interface GetForumList {}
+    GetAnnouncementLatest: {};
+}