speedruncom.js 1.2.3 → 1.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/Client.d.ts CHANGED
@@ -30,191 +30,191 @@ export default class Client {
30
30
  * Attempts to remove the PHPSESSID cookie if using a browser, otherwise removes your Client's authentication.
31
31
  */
32
32
  logout(): Promise<unknown>;
33
- GetGameLeaderboard2(params?: GetEndpoints.GetGameLeaderboard2): Promise<Readonly<Responses.GetGameLeaderboard2>>;
34
- static GetGameLeaderboard2(params?: GetEndpoints.GetGameLeaderboard2): Promise<Readonly<Responses.GetGameLeaderboard2>>;
35
- GetGameLeaderboard(params?: GetEndpoints.GetGameLeaderboard): Promise<Readonly<Responses.GetGameLeaderboard>>;
36
- static GetGameLeaderboard(params?: GetEndpoints.GetGameLeaderboard): Promise<Readonly<Responses.GetGameLeaderboard>>;
37
- GetGameData(params: GetEndpoints.GetGameData): Promise<Readonly<Responses.GetGameData>>;
38
- static GetGameData(params: GetEndpoints.GetGameData): Promise<Readonly<Responses.GetGameData>>;
39
- GetGameSummary(params: GetEndpoints.GetGameSummary): Promise<Readonly<Responses.GetGameSummary>>;
40
- static GetGameSummary(params: GetEndpoints.GetGameSummary): Promise<Readonly<Responses.GetGameSummary>>;
41
- GetGameRecordHistory(params: GetEndpoints.GetGameRecordHistory): Promise<Readonly<Responses.GetGameRecordHistory>>;
42
- static GetGameRecordHistory(params: GetEndpoints.GetGameRecordHistory): Promise<Readonly<Responses.GetGameRecordHistory>>;
43
- GetSearch(params: GetEndpoints.GetSearch): Promise<Readonly<Responses.GetSearch>>;
44
- static GetSearch(params: GetEndpoints.GetSearch): Promise<Readonly<Responses.GetSearch>>;
45
- GetLatestLeaderboard(params: GetEndpoints.GetLatestLeaderboard): Promise<Readonly<Responses.GetLatestLeaderboard>>;
46
- static GetLatestLeaderboard(params: GetEndpoints.GetLatestLeaderboard): Promise<Readonly<Responses.GetLatestLeaderboard>>;
47
- GetRun(params?: GetEndpoints.GetRun): Promise<Readonly<Responses.GetRun>>;
48
- static GetRun(params?: GetEndpoints.GetRun): Promise<Readonly<Responses.GetRun>>;
49
- GetUserSummary(params?: GetEndpoints.GetUserSummary): Promise<Readonly<Responses.GetUserSummary>>;
50
- static GetUserSummary(params?: GetEndpoints.GetUserSummary): Promise<Readonly<Responses.GetUserSummary>>;
51
- GetUserComments(params?: GetEndpoints.GetUserComments): Promise<Readonly<Responses.GetUserComments>>;
52
- static GetUserComments(params?: GetEndpoints.GetUserComments): Promise<Readonly<Responses.GetUserComments>>;
53
- GetUserThreads(params?: GetEndpoints.GetUserThreads): Promise<Readonly<Responses.GetUserThreads>>;
54
- static GetUserThreads(params?: GetEndpoints.GetUserThreads): Promise<Readonly<Responses.GetUserThreads>>;
55
- GetUserPopoverData(params?: GetEndpoints.GetUserPopoverData): Promise<Readonly<Responses.GetUserPopoverData>>;
56
- static GetUserPopoverData(params?: GetEndpoints.GetUserPopoverData): Promise<Readonly<Responses.GetUserPopoverData>>;
33
+ GetGameLeaderboard2(params: GetEndpoints.GetGameLeaderboard2): Promise<Readonly<Responses.GetGameLeaderboard2>>;
34
+ static GetGameLeaderboard2(params: GetEndpoints.GetGameLeaderboard2): Promise<Readonly<Responses.GetGameLeaderboard2>>;
35
+ GetGameLeaderboard(params: GetEndpoints.GetGameLeaderboard): Promise<Readonly<Responses.GetGameLeaderboard>>;
36
+ static GetGameLeaderboard(params: GetEndpoints.GetGameLeaderboard): Promise<Readonly<Responses.GetGameLeaderboard>>;
37
+ GetGameData(params?: GetEndpoints.GetGameData): Promise<Readonly<Responses.GetGameData>>;
38
+ static GetGameData(params?: GetEndpoints.GetGameData): Promise<Readonly<Responses.GetGameData>>;
39
+ GetGameSummary(params?: GetEndpoints.GetGameSummary): Promise<Readonly<Responses.GetGameSummary>>;
40
+ static GetGameSummary(params?: GetEndpoints.GetGameSummary): Promise<Readonly<Responses.GetGameSummary>>;
41
+ GetGameRecordHistory(params?: GetEndpoints.GetGameRecordHistory): Promise<Readonly<Responses.GetGameRecordHistory>>;
42
+ static GetGameRecordHistory(params?: GetEndpoints.GetGameRecordHistory): Promise<Readonly<Responses.GetGameRecordHistory>>;
43
+ GetSearch(params?: GetEndpoints.GetSearch): Promise<Readonly<Responses.GetSearch>>;
44
+ static GetSearch(params?: GetEndpoints.GetSearch): Promise<Readonly<Responses.GetSearch>>;
45
+ GetLatestLeaderboard(params?: GetEndpoints.GetLatestLeaderboard): Promise<Readonly<Responses.GetLatestLeaderboard>>;
46
+ static GetLatestLeaderboard(params?: GetEndpoints.GetLatestLeaderboard): Promise<Readonly<Responses.GetLatestLeaderboard>>;
47
+ GetRun(params: GetEndpoints.GetRun): Promise<Readonly<Responses.GetRun>>;
48
+ static GetRun(params: GetEndpoints.GetRun): Promise<Readonly<Responses.GetRun>>;
49
+ GetUserSummary(params: GetEndpoints.GetUserSummary): Promise<Readonly<Responses.GetUserSummary>>;
50
+ static GetUserSummary(params: GetEndpoints.GetUserSummary): Promise<Readonly<Responses.GetUserSummary>>;
51
+ GetUserComments(params: GetEndpoints.GetUserComments): Promise<Readonly<Responses.GetUserComments>>;
52
+ static GetUserComments(params: GetEndpoints.GetUserComments): Promise<Readonly<Responses.GetUserComments>>;
53
+ GetUserThreads(params: GetEndpoints.GetUserThreads): Promise<Readonly<Responses.GetUserThreads>>;
54
+ static GetUserThreads(params: GetEndpoints.GetUserThreads): Promise<Readonly<Responses.GetUserThreads>>;
55
+ GetUserPopoverData(params: GetEndpoints.GetUserPopoverData): Promise<Readonly<Responses.GetUserPopoverData>>;
56
+ static GetUserPopoverData(params: GetEndpoints.GetUserPopoverData): Promise<Readonly<Responses.GetUserPopoverData>>;
57
57
  GetTitleList(): Promise<Readonly<Responses.GetTitleList>>;
58
58
  static GetTitleList(): Promise<Readonly<Responses.GetTitleList>>;
59
- GetTitle(params?: GetEndpoints.GetTitle): Promise<Readonly<Responses.GetTitle>>;
60
- static GetTitle(params?: GetEndpoints.GetTitle): Promise<Readonly<Responses.GetTitle>>;
61
- GetArticleList(params: GetEndpoints.GetArticleList): Promise<Readonly<Responses.GetArticleList>>;
62
- static GetArticleList(params: GetEndpoints.GetArticleList): Promise<Readonly<Responses.GetArticleList>>;
63
- GetArticle(params: GetEndpoints.GetArticle): Promise<Readonly<Responses.GetArticle>>;
64
- static GetArticle(params: GetEndpoints.GetArticle): Promise<Readonly<Responses.GetArticle>>;
65
- GetGameList(params: GetEndpoints.GetGameList): Promise<Readonly<Responses.GetGameList>>;
66
- static GetGameList(params: GetEndpoints.GetGameList): Promise<Readonly<Responses.GetGameList>>;
59
+ GetTitle(params: GetEndpoints.GetTitle): Promise<Readonly<Responses.GetTitle>>;
60
+ static GetTitle(params: GetEndpoints.GetTitle): Promise<Readonly<Responses.GetTitle>>;
61
+ GetArticleList(params?: GetEndpoints.GetArticleList): Promise<Readonly<Responses.GetArticleList>>;
62
+ static GetArticleList(params?: GetEndpoints.GetArticleList): Promise<Readonly<Responses.GetArticleList>>;
63
+ GetArticle(params?: GetEndpoints.GetArticle): Promise<Readonly<Responses.GetArticle>>;
64
+ static GetArticle(params?: GetEndpoints.GetArticle): Promise<Readonly<Responses.GetArticle>>;
65
+ GetGameList(params?: GetEndpoints.GetGameList): Promise<Readonly<Responses.GetGameList>>;
66
+ static GetGameList(params?: GetEndpoints.GetGameList): Promise<Readonly<Responses.GetGameList>>;
67
67
  GetPlatformList(): Promise<Readonly<Responses.GetPlatformList>>;
68
68
  static GetPlatformList(): Promise<Readonly<Responses.GetPlatformList>>;
69
69
  GetHomeSummary(): Promise<Readonly<Responses.GetHomeSummary>>;
70
70
  static GetHomeSummary(): Promise<Readonly<Responses.GetHomeSummary>>;
71
- GetSeriesList(params: GetEndpoints.GetSeriesList): Promise<Readonly<Responses.GetSeriesList>>;
72
- static GetSeriesList(params: GetEndpoints.GetSeriesList): Promise<Readonly<Responses.GetSeriesList>>;
73
- GetSeriesSummary(params?: GetEndpoints.GetSeriesSummary): Promise<Readonly<Responses.GetSeriesSummary>>;
74
- static GetSeriesSummary(params?: GetEndpoints.GetSeriesSummary): Promise<Readonly<Responses.GetSeriesSummary>>;
75
- GetGameLevelSummary(params: GetEndpoints.GetGameLevelSummary): Promise<Readonly<Responses.GetGameLevelSummary>>;
76
- static GetGameLevelSummary(params: GetEndpoints.GetGameLevelSummary): Promise<Readonly<Responses.GetGameLevelSummary>>;
71
+ GetSeriesList(params?: GetEndpoints.GetSeriesList): Promise<Readonly<Responses.GetSeriesList>>;
72
+ static GetSeriesList(params?: GetEndpoints.GetSeriesList): Promise<Readonly<Responses.GetSeriesList>>;
73
+ GetSeriesSummary(params: GetEndpoints.GetSeriesSummary): Promise<Readonly<Responses.GetSeriesSummary>>;
74
+ static GetSeriesSummary(params: GetEndpoints.GetSeriesSummary): Promise<Readonly<Responses.GetSeriesSummary>>;
75
+ GetGameLevelSummary(params?: GetEndpoints.GetGameLevelSummary): Promise<Readonly<Responses.GetGameLevelSummary>>;
76
+ static GetGameLevelSummary(params?: GetEndpoints.GetGameLevelSummary): Promise<Readonly<Responses.GetGameLevelSummary>>;
77
77
  GetGameRandom(): Promise<Readonly<Responses.GetGameRandom>>;
78
78
  static GetGameRandom(): Promise<Readonly<Responses.GetGameRandom>>;
79
- GetGuideList(params?: GetEndpoints.GetGuideList): Promise<Readonly<Responses.GetGuideList>>;
80
- static GetGuideList(params?: GetEndpoints.GetGuideList): Promise<Readonly<Responses.GetGuideList>>;
81
- GetGuide(params?: GetEndpoints.GetGuide): Promise<Readonly<Responses.GetGuide>>;
82
- static GetGuide(params?: GetEndpoints.GetGuide): Promise<Readonly<Responses.GetGuide>>;
83
- GetNewsList(params?: GetEndpoints.GetNewsList): Promise<Readonly<Responses.GetNewsList>>;
84
- static GetNewsList(params?: GetEndpoints.GetNewsList): Promise<Readonly<Responses.GetNewsList>>;
85
- GetNews(params?: GetEndpoints.GetNews): Promise<Readonly<Responses.GetNews>>;
86
- static GetNews(params?: GetEndpoints.GetNews): Promise<Readonly<Responses.GetNews>>;
87
- GetResourceList(params?: GetEndpoints.GetResourceList): Promise<Readonly<Responses.GetResourceList>>;
88
- static GetResourceList(params?: GetEndpoints.GetResourceList): Promise<Readonly<Responses.GetResourceList>>;
89
- GetStreamList(params: GetEndpoints.GetStreamList): Promise<Readonly<Responses.GetStreamList>>;
90
- static GetStreamList(params: GetEndpoints.GetStreamList): Promise<Readonly<Responses.GetStreamList>>;
91
- GetThreadList(params?: GetEndpoints.GetThreadList): Promise<Readonly<Responses.GetThreadList>>;
92
- static GetThreadList(params?: GetEndpoints.GetThreadList): Promise<Readonly<Responses.GetThreadList>>;
93
- GetThreadStateByCommentId(params?: GetEndpoints.GetThreadStateByCommentId): Promise<Readonly<Responses.GetThreadStateByCommentId>>;
94
- static GetThreadStateByCommentId(params?: GetEndpoints.GetThreadStateByCommentId): Promise<Readonly<Responses.GetThreadStateByCommentId>>;
95
- GetChallenge(params?: GetEndpoints.GetChallenge): Promise<Readonly<Responses.GetChallenge>>;
96
- static GetChallenge(params?: GetEndpoints.GetChallenge): Promise<Readonly<Responses.GetChallenge>>;
97
- GetChallengeLeaderboard(params?: GetEndpoints.GetChallengeLeaderboard): Promise<Readonly<Responses.GetChallengeLeaderboard>>;
98
- static GetChallengeLeaderboard(params?: GetEndpoints.GetChallengeLeaderboard): Promise<Readonly<Responses.GetChallengeLeaderboard>>;
79
+ GetGuideList(params: GetEndpoints.GetGuideList): Promise<Readonly<Responses.GetGuideList>>;
80
+ static GetGuideList(params: GetEndpoints.GetGuideList): Promise<Readonly<Responses.GetGuideList>>;
81
+ GetGuide(params: GetEndpoints.GetGuide): Promise<Readonly<Responses.GetGuide>>;
82
+ static GetGuide(params: GetEndpoints.GetGuide): Promise<Readonly<Responses.GetGuide>>;
83
+ GetNewsList(params: GetEndpoints.GetNewsList): Promise<Readonly<Responses.GetNewsList>>;
84
+ static GetNewsList(params: GetEndpoints.GetNewsList): Promise<Readonly<Responses.GetNewsList>>;
85
+ GetNews(params: GetEndpoints.GetNews): Promise<Readonly<Responses.GetNews>>;
86
+ static GetNews(params: GetEndpoints.GetNews): Promise<Readonly<Responses.GetNews>>;
87
+ GetResourceList(params: GetEndpoints.GetResourceList): Promise<Readonly<Responses.GetResourceList>>;
88
+ static GetResourceList(params: GetEndpoints.GetResourceList): Promise<Readonly<Responses.GetResourceList>>;
89
+ GetStreamList(params?: GetEndpoints.GetStreamList): Promise<Readonly<Responses.GetStreamList>>;
90
+ static GetStreamList(params?: GetEndpoints.GetStreamList): Promise<Readonly<Responses.GetStreamList>>;
91
+ GetThreadList(params: GetEndpoints.GetThreadList): Promise<Readonly<Responses.GetThreadList>>;
92
+ static GetThreadList(params: GetEndpoints.GetThreadList): Promise<Readonly<Responses.GetThreadList>>;
93
+ GetThreadStateByCommentId(params: GetEndpoints.GetThreadStateByCommentId): Promise<Readonly<Responses.GetThreadStateByCommentId>>;
94
+ static GetThreadStateByCommentId(params: GetEndpoints.GetThreadStateByCommentId): Promise<Readonly<Responses.GetThreadStateByCommentId>>;
95
+ GetChallenge(params: GetEndpoints.GetChallenge): Promise<Readonly<Responses.GetChallenge>>;
96
+ static GetChallenge(params: GetEndpoints.GetChallenge): Promise<Readonly<Responses.GetChallenge>>;
97
+ GetChallengeLeaderboard(params: GetEndpoints.GetChallengeLeaderboard): Promise<Readonly<Responses.GetChallengeLeaderboard>>;
98
+ static GetChallengeLeaderboard(params: GetEndpoints.GetChallengeLeaderboard): Promise<Readonly<Responses.GetChallengeLeaderboard>>;
99
99
  GetChallengeGlobalRankingList(): Promise<Readonly<Responses.GetChallengeGlobalRankingList>>;
100
100
  static GetChallengeGlobalRankingList(): Promise<Readonly<Responses.GetChallengeGlobalRankingList>>;
101
- GetChallengeRun(params?: GetEndpoints.GetChallengeRun): Promise<Readonly<Responses.GetChallengeRun>>;
102
- static GetChallengeRun(params?: GetEndpoints.GetChallengeRun): Promise<Readonly<Responses.GetChallengeRun>>;
103
- GetUserLeaderboard(params?: GetEndpoints.GetUserLeaderboard): Promise<Readonly<Responses.GetUserLeaderboard>>;
104
- static GetUserLeaderboard(params?: GetEndpoints.GetUserLeaderboard): Promise<Readonly<Responses.GetUserLeaderboard>>;
105
- GetUserModeration(params?: GetEndpoints.GetUserModeration): Promise<Readonly<Responses.GetUserModeration>>;
106
- static GetUserModeration(params?: GetEndpoints.GetUserModeration): Promise<Readonly<Responses.GetUserModeration>>;
107
- GetCommentList(params?: GetEndpoints.GetCommentList): Promise<Readonly<Responses.GetCommentList>>;
108
- static GetCommentList(params?: GetEndpoints.GetCommentList): Promise<Readonly<Responses.GetCommentList>>;
109
- GetThread(params?: GetEndpoints.GetThread): Promise<Readonly<Responses.GetThread>>;
110
- static GetThread(params?: GetEndpoints.GetThread): Promise<Readonly<Responses.GetThread>>;
101
+ GetChallengeRun(params: GetEndpoints.GetChallengeRun): Promise<Readonly<Responses.GetChallengeRun>>;
102
+ static GetChallengeRun(params: GetEndpoints.GetChallengeRun): Promise<Readonly<Responses.GetChallengeRun>>;
103
+ GetUserLeaderboard(params: GetEndpoints.GetUserLeaderboard): Promise<Readonly<Responses.GetUserLeaderboard>>;
104
+ static GetUserLeaderboard(params: GetEndpoints.GetUserLeaderboard): Promise<Readonly<Responses.GetUserLeaderboard>>;
105
+ GetUserModeration(params: GetEndpoints.GetUserModeration): Promise<Readonly<Responses.GetUserModeration>>;
106
+ static GetUserModeration(params: GetEndpoints.GetUserModeration): Promise<Readonly<Responses.GetUserModeration>>;
107
+ GetCommentList(params: GetEndpoints.GetCommentList): Promise<Readonly<Responses.GetCommentList>>;
108
+ static GetCommentList(params: GetEndpoints.GetCommentList): Promise<Readonly<Responses.GetCommentList>>;
109
+ GetThread(params: GetEndpoints.GetThread): Promise<Readonly<Responses.GetThread>>;
110
+ static GetThread(params: GetEndpoints.GetThread): Promise<Readonly<Responses.GetThread>>;
111
111
  GetStaticData(): Promise<Readonly<Responses.GetStaticData>>;
112
112
  static GetStaticData(): Promise<Readonly<Responses.GetStaticData>>;
113
113
  GetForumList(): Promise<Readonly<Responses.GetForumList>>;
114
114
  static GetForumList(): Promise<Readonly<Responses.GetForumList>>;
115
- PutAuthLogin(params?: PostEndpoints.PutAuthLogin): Promise<Readonly<Responses.PutAuthLogin>>;
115
+ PutAuthLogin(params: PostEndpoints.PutAuthLogin): Promise<Readonly<Responses.PutAuthLogin>>;
116
116
  GetSession(): Promise<Readonly<Responses.GetSession>>;
117
117
  PutSessionPing(): Promise<void>;
118
- GetAuditLogList(params: PostEndpoints.GetAuditLogList): Promise<Readonly<Responses.GetAuditLogList>>;
119
- GetGameSettings(params?: PostEndpoints.GetGameSettings): Promise<Readonly<Responses.GetGameSettings>>;
120
- PutGameSettings(params?: PostEndpoints.PutGameSettings): Promise<void>;
121
- PutCategory(params?: PostEndpoints.PutCategory): Promise<void>;
122
- PutCategoryUpdate(params?: PostEndpoints.PutCategoryUpdate): Promise<void>;
123
- PutCategoryArchive(params?: PostEndpoints.PutCategoryArchive): Promise<void>;
124
- PutCategoryRestore(params?: PostEndpoints.PutCategoryRestore): Promise<void>;
125
- PutCategoryOrder(params?: PostEndpoints.PutCategoryOrder): Promise<void>;
126
- PutLevel(params?: PostEndpoints.PutLevel): Promise<void>;
127
- PutLevelUpdate(params?: PostEndpoints.PutLevelUpdate): Promise<void>;
128
- PutLevelArchive(params?: PostEndpoints.PutLevelArchive): Promise<void>;
129
- PutLevelRestore(params?: PostEndpoints.PutLevelRestore): Promise<void>;
130
- PutLevelOrder(params?: PostEndpoints.PutLevelOrder): Promise<void>;
131
- PutVariable(params?: PostEndpoints.PutVariable): Promise<void>;
132
- PutVariableUpdate(params?: PostEndpoints.PutVariableUpdate): Promise<void>;
133
- PutVariableArchive(params?: PostEndpoints.PutVariableArchive): Promise<void>;
134
- PutVariableRestore(params?: PostEndpoints.PutVariableRestore): Promise<void>;
135
- PutVariableOrder(params?: PostEndpoints.PutVariableOrder): Promise<void>;
136
- PutVariableApplyDefault(params?: PostEndpoints.PutVariableApplyDefault): Promise<void>;
137
- PutNews(params?: PostEndpoints.PutNews): Promise<void>;
138
- PutNewsUpdate(params?: PostEndpoints.PutNewsUpdate): Promise<void>;
139
- PutNewsDelete(params?: PostEndpoints.PutNewsDelete): Promise<void>;
140
- PutGuide(params?: PostEndpoints.PutGuide): Promise<void>;
141
- PutGuideUpdate(params?: PostEndpoints.PutGuideUpdate): Promise<void>;
142
- PutGuideDelete(params?: PostEndpoints.PutGuideDelete): Promise<void>;
143
- PutResource(params?: PostEndpoints.PutResource): Promise<void>;
144
- PutResourceUpdate(params?: PostEndpoints.PutResourceUpdate): Promise<void>;
145
- PutResourceDelete(params?: PostEndpoints.PutResourceDelete): Promise<void>;
118
+ GetAuditLogList(params?: PostEndpoints.GetAuditLogList): Promise<Readonly<Responses.GetAuditLogList>>;
119
+ GetGameSettings(params: PostEndpoints.GetGameSettings): Promise<Readonly<Responses.GetGameSettings>>;
120
+ PutGameSettings(params: PostEndpoints.PutGameSettings): Promise<void>;
121
+ PutCategory(params: PostEndpoints.PutCategory): Promise<void>;
122
+ PutCategoryUpdate(params: PostEndpoints.PutCategoryUpdate): Promise<void>;
123
+ PutCategoryArchive(params: PostEndpoints.PutCategoryArchive): Promise<void>;
124
+ PutCategoryRestore(params: PostEndpoints.PutCategoryRestore): Promise<void>;
125
+ PutCategoryOrder(params: PostEndpoints.PutCategoryOrder): Promise<void>;
126
+ PutLevel(params: PostEndpoints.PutLevel): Promise<void>;
127
+ PutLevelUpdate(params: PostEndpoints.PutLevelUpdate): Promise<void>;
128
+ PutLevelArchive(params: PostEndpoints.PutLevelArchive): Promise<void>;
129
+ PutLevelRestore(params: PostEndpoints.PutLevelRestore): Promise<void>;
130
+ PutLevelOrder(params: PostEndpoints.PutLevelOrder): Promise<void>;
131
+ PutVariable(params: PostEndpoints.PutVariable): Promise<void>;
132
+ PutVariableUpdate(params: PostEndpoints.PutVariableUpdate): Promise<void>;
133
+ PutVariableArchive(params: PostEndpoints.PutVariableArchive): Promise<void>;
134
+ PutVariableRestore(params: PostEndpoints.PutVariableRestore): Promise<void>;
135
+ PutVariableOrder(params: PostEndpoints.PutVariableOrder): Promise<void>;
136
+ PutVariableApplyDefault(params: PostEndpoints.PutVariableApplyDefault): Promise<void>;
137
+ PutNews(params: PostEndpoints.PutNews): Promise<void>;
138
+ PutNewsUpdate(params: PostEndpoints.PutNewsUpdate): Promise<void>;
139
+ PutNewsDelete(params: PostEndpoints.PutNewsDelete): Promise<void>;
140
+ PutGuide(params: PostEndpoints.PutGuide): Promise<void>;
141
+ PutGuideUpdate(params: PostEndpoints.PutGuideUpdate): Promise<void>;
142
+ PutGuideDelete(params: PostEndpoints.PutGuideDelete): Promise<void>;
143
+ PutResource(params: PostEndpoints.PutResource): Promise<void>;
144
+ PutResourceUpdate(params: PostEndpoints.PutResourceUpdate): Promise<void>;
145
+ PutResourceDelete(params: PostEndpoints.PutResourceDelete): Promise<void>;
146
146
  GetModerationGames(): Promise<Readonly<Responses.GetModerationGames>>;
147
- GetModerationRuns(params?: PostEndpoints.GetModerationRuns): Promise<Readonly<Responses.GetModerationRuns>>;
148
- PutRunAssignee(params?: PostEndpoints.PutRunAssignee): Promise<void>;
149
- PutRunDelete(params?: PostEndpoints.PutRunDelete): Promise<void>;
150
- PutRunVerification(params?: PostEndpoints.PutRunVerification): Promise<void>;
151
- PutRunVideoState(params?: PostEndpoints.PutRunVideoState): Promise<void>;
152
- GetRunSettings(params?: PostEndpoints.GetRunSettings): Promise<Readonly<Responses.GetRunSettings>>;
153
- PutRunSettings(params?: PostEndpoints.PutRunSettings): Promise<Readonly<Responses.PutRunSettings>>;
147
+ GetModerationRuns(params: PostEndpoints.GetModerationRuns): Promise<Readonly<Responses.GetModerationRuns>>;
148
+ PutRunAssignee(params: PostEndpoints.PutRunAssignee): Promise<void>;
149
+ PutRunDelete(params: PostEndpoints.PutRunDelete): Promise<void>;
150
+ PutRunVerification(params: PostEndpoints.PutRunVerification): Promise<void>;
151
+ PutRunVideoState(params: PostEndpoints.PutRunVideoState): Promise<void>;
152
+ GetRunSettings(params: PostEndpoints.GetRunSettings): Promise<Readonly<Responses.GetRunSettings>>;
153
+ PutRunSettings(params: PostEndpoints.PutRunSettings): Promise<Readonly<Responses.PutRunSettings>>;
154
154
  GetConversations(): Promise<Readonly<Responses.GetConversations>>;
155
- GetConversationMessages(params?: PostEndpoints.GetConversationMessages): Promise<Readonly<Responses.GetConversationMessages>>;
156
- PutConversation(params?: PostEndpoints.PutConversation): Promise<Readonly<Responses.PutConversation>>;
157
- PutConversationMessage(params?: PostEndpoints.PutConversationMessage): Promise<Readonly<Responses.PutConversationMessage>>;
158
- PutConversationLeave(params?: PostEndpoints.PutConversationLeave): Promise<void>;
159
- PutConversationReport(params?: PostEndpoints.PutConversationReport): Promise<void>;
155
+ GetConversationMessages(params: PostEndpoints.GetConversationMessages): Promise<Readonly<Responses.GetConversationMessages>>;
156
+ PutConversation(params: PostEndpoints.PutConversation): Promise<Readonly<Responses.PutConversation>>;
157
+ PutConversationMessage(params: PostEndpoints.PutConversationMessage): Promise<Readonly<Responses.PutConversationMessage>>;
158
+ PutConversationLeave(params: PostEndpoints.PutConversationLeave): Promise<void>;
159
+ PutConversationReport(params: PostEndpoints.PutConversationReport): Promise<void>;
160
160
  GetNotifications(): Promise<Readonly<Responses.GetNotifications>>;
161
161
  PutNotificationsRead(): Promise<void>;
162
- PutGameFollower(params?: PostEndpoints.PutGameFollower): Promise<void>;
163
- PutGameFollowerDelete(params?: PostEndpoints.PutGameFollowerDelete): Promise<void>;
164
- PutUserFollower(params?: PostEndpoints.PutUserFollower): Promise<void>;
165
- PutUserFollowerDelete(params?: PostEndpoints.PutUserFollowerDelete): Promise<void>;
166
- GetUserSettings(params?: PostEndpoints.GetUserSettings): Promise<Readonly<Responses.GetUserSettings>>;
167
- PutUserSettings(params?: PostEndpoints.PutUserSettings): Promise<Readonly<Responses.PutUserSettings>>;
168
- PutUserUpdateFeaturedRun(params?: PostEndpoints.PutUserUpdateFeaturedRun): Promise<void>;
169
- PutUserUpdateGameOrdering(params?: PostEndpoints.PutUserUpdateGameOrdering): Promise<void>;
170
- GetUserApiKey(params?: PostEndpoints.GetUserApiKey): Promise<Readonly<Responses.GetUserApiKey>>;
171
- GetUserFollowers(params?: PostEndpoints.GetUserFollowers): Promise<Readonly<Responses.GetUserFollowers>>;
172
- GetUserFollowingGames(params?: PostEndpoints.GetUserFollowingGames): Promise<Readonly<Responses.GetUserFollowingGames>>;
173
- GetUserFollowingUsers(params?: PostEndpoints.GetUserFollowingUsers): Promise<Readonly<Responses.GetUserFollowingUsers>>;
174
- GetUserGameBoostData(params?: PostEndpoints.GetUserGameBoostData): Promise<Readonly<Responses.GetUserGameBoostData>>;
175
- GetUserDataExport(params?: PostEndpoints.GetUserDataExport): Promise<Readonly<Responses.GetUserDataExport>>;
176
- PutGameFollowerOrder(params?: PostEndpoints.PutGameFollowerOrder): Promise<void>;
177
- PutArticleSubmission(params?: PostEndpoints.PutArticleSubmission): Promise<void>;
178
- GetCommentable(params?: PostEndpoints.GetCommentable): Promise<Readonly<Responses.GetCommentable>>;
179
- PutComment(params?: PostEndpoints.PutComment): Promise<void>;
180
- PutLike(params?: PostEndpoints.PutLike): Promise<Readonly<Responses.PutLike>>;
181
- PutCommentableSettings(params?: PostEndpoints.PutCommentableSettings): Promise<void>;
182
- GetThreadReadStatus(params?: PostEndpoints.GetThreadReadStatus): Promise<Readonly<Responses.GetThreadReadStatus>>;
183
- PutThreadRead(params?: PostEndpoints.PutThreadRead): Promise<void>;
184
- GetForumReadStatus(params?: PostEndpoints.GetForumReadStatus): Promise<Readonly<Responses.GetForumReadStatus>>;
185
- GetThemeSettings(params: PostEndpoints.GetThemeSettings): Promise<Readonly<Responses.GetThemeSettings>>;
186
- PutThemeSettings(params?: PostEndpoints.PutThemeSettings): Promise<void>;
187
- GetUserSupporterData(params?: PostEndpoints.GetUserSupporterData): Promise<Readonly<Responses.GetUserSupporterData>>;
188
- PutUserSupporterNewSubscription(params: PostEndpoints.PutUserSupporterNewSubscription): Promise<Readonly<Responses.PutUserSupporterNewSubscription>>;
189
- PutGameBoostGrant(params?: PostEndpoints.PutGameBoostGrant): Promise<void>;
190
- PutAdvertiseContact(params?: PostEndpoints.PutAdvertiseContact): Promise<void>;
191
- GetTickets(params?: PostEndpoints.GetTickets): Promise<Readonly<Responses.GetTickets>>;
192
- GetSeriesSettings(params?: PostEndpoints.GetSeriesSettings): Promise<Readonly<Responses.GetSeriesSettings>>;
162
+ PutGameFollower(params: PostEndpoints.PutGameFollower): Promise<void>;
163
+ PutGameFollowerDelete(params: PostEndpoints.PutGameFollowerDelete): Promise<void>;
164
+ PutUserFollower(params: PostEndpoints.PutUserFollower): Promise<void>;
165
+ PutUserFollowerDelete(params: PostEndpoints.PutUserFollowerDelete): Promise<void>;
166
+ GetUserSettings(params: PostEndpoints.GetUserSettings): Promise<Readonly<Responses.GetUserSettings>>;
167
+ PutUserSettings(params: PostEndpoints.PutUserSettings): Promise<Readonly<Responses.PutUserSettings>>;
168
+ PutUserUpdateFeaturedRun(params: PostEndpoints.PutUserUpdateFeaturedRun): Promise<void>;
169
+ PutUserUpdateGameOrdering(params: PostEndpoints.PutUserUpdateGameOrdering): Promise<void>;
170
+ GetUserApiKey(params: PostEndpoints.GetUserApiKey): Promise<Readonly<Responses.GetUserApiKey>>;
171
+ GetUserFollowers(params: PostEndpoints.GetUserFollowers): Promise<Readonly<Responses.GetUserFollowers>>;
172
+ GetUserFollowingGames(params: PostEndpoints.GetUserFollowingGames): Promise<Readonly<Responses.GetUserFollowingGames>>;
173
+ GetUserFollowingUsers(params: PostEndpoints.GetUserFollowingUsers): Promise<Readonly<Responses.GetUserFollowingUsers>>;
174
+ GetUserGameBoostData(params: PostEndpoints.GetUserGameBoostData): Promise<Readonly<Responses.GetUserGameBoostData>>;
175
+ GetUserDataExport(params: PostEndpoints.GetUserDataExport): Promise<Readonly<Responses.GetUserDataExport>>;
176
+ PutGameFollowerOrder(params: PostEndpoints.PutGameFollowerOrder): Promise<void>;
177
+ PutArticleSubmission(params: PostEndpoints.PutArticleSubmission): Promise<void>;
178
+ GetCommentable(params: PostEndpoints.GetCommentable): Promise<Readonly<Responses.GetCommentable>>;
179
+ PutComment(params: PostEndpoints.PutComment): Promise<void>;
180
+ PutLike(params: PostEndpoints.PutLike): Promise<Readonly<Responses.PutLike>>;
181
+ PutCommentableSettings(params: PostEndpoints.PutCommentableSettings): Promise<void>;
182
+ GetThreadReadStatus(params: PostEndpoints.GetThreadReadStatus): Promise<Readonly<Responses.GetThreadReadStatus>>;
183
+ PutThreadRead(params: PostEndpoints.PutThreadRead): Promise<void>;
184
+ GetForumReadStatus(params: PostEndpoints.GetForumReadStatus): Promise<Readonly<Responses.GetForumReadStatus>>;
185
+ GetThemeSettings(params?: PostEndpoints.GetThemeSettings): Promise<Readonly<Responses.GetThemeSettings>>;
186
+ PutThemeSettings(params: PostEndpoints.PutThemeSettings): Promise<void>;
187
+ GetUserSupporterData(params: PostEndpoints.GetUserSupporterData): Promise<Readonly<Responses.GetUserSupporterData>>;
188
+ PutUserSupporterNewSubscription(params?: PostEndpoints.PutUserSupporterNewSubscription): Promise<Readonly<Responses.PutUserSupporterNewSubscription>>;
189
+ PutGameBoostGrant(params: PostEndpoints.PutGameBoostGrant): Promise<void>;
190
+ PutAdvertiseContact(params: PostEndpoints.PutAdvertiseContact): Promise<void>;
191
+ GetTickets(params: PostEndpoints.GetTickets): Promise<Readonly<Responses.GetTickets>>;
192
+ GetSeriesSettings(params: PostEndpoints.GetSeriesSettings): Promise<Readonly<Responses.GetSeriesSettings>>;
193
193
  GetUserBlocks(): Promise<Readonly<Responses.GetUserBlocks>>;
194
- PutUserBlock(params?: PostEndpoints.PutUserBlock): Promise<void>;
195
- PutGame(params?: PostEndpoints.PutGame): Promise<Readonly<Responses.PutGame>>;
194
+ PutUserBlock(params: PostEndpoints.PutUserBlock): Promise<void>;
195
+ PutGame(params: PostEndpoints.PutGame): Promise<Readonly<Responses.PutGame>>;
196
196
  PutGameModerator(): Promise<void>;
197
- PutGameModeratorDelete(params?: PostEndpoints.PutGameModeratorDelete): Promise<void>;
198
- PutSeriesGame(params?: PostEndpoints.PutSeriesGame): Promise<void>;
199
- PutSeriesGameDelete(params?: PostEndpoints.PutSeriesGameDelete): Promise<void>;
197
+ PutGameModeratorDelete(params: PostEndpoints.PutGameModeratorDelete): Promise<void>;
198
+ PutSeriesGame(params: PostEndpoints.PutSeriesGame): Promise<void>;
199
+ PutSeriesGameDelete(params: PostEndpoints.PutSeriesGameDelete): Promise<void>;
200
200
  PutSeriesModerator(): Promise<void>;
201
201
  PutSeriesModeratorUpdate(): Promise<void>;
202
202
  PutSeriesModeratorDelete(): Promise<void>;
203
- PutSeriesSettings(params?: PostEndpoints.PutSeriesSettings): Promise<void>;
204
- PutTicket(params?: PostEndpoints.PutTicket): Promise<Readonly<Responses.PutTicket>>;
205
- PutTicketNote(params?: PostEndpoints.PutTicketNote): Promise<void>;
206
- PutUserSocialConnection(params?: PostEndpoints.PutUserSocialConnection): Promise<void>;
207
- PutUserSocialConnectionDelete(params?: PostEndpoints.PutUserSocialConnectionDelete): Promise<void>;
208
- PutUserSocialConnectionSsoExchange(params?: PostEndpoints.PutUserSocialConnectionSsoExchange): Promise<void>;
209
- PutUserUpdatePassword(params?: PostEndpoints.PutUserUpdatePassword): Promise<void>;
210
- PutUserUpdateEmail(params?: PostEndpoints.PutUserUpdateEmail): Promise<Readonly<Responses.PutUserUpdateEmail>>;
211
- PutUserUpdateName(params?: PostEndpoints.PutUserUpdateName): Promise<Readonly<Responses.PutUserUpdateName>>;
212
- PutUserDelete(params?: PostEndpoints.PutUserDelete): Promise<void>;
213
- PutCommentUpdate(params?: PostEndpoints.PutCommentUpdate): Promise<void>;
214
- PutCommentDelete(params?: PostEndpoints.PutCommentDelete): Promise<void>;
215
- PutCommentRestore(params?: PostEndpoints.PutCommentRestore): Promise<void>;
216
- PutThread(params?: PostEndpoints.PutThread): Promise<Readonly<Responses.PutThread>>;
217
- PutThreadLocked(params?: PostEndpoints.PutThreadLocked): Promise<void>;
218
- PutThreadSticky(params?: PostEndpoints.PutThreadSticky): Promise<void>;
219
- PutThreadDelete(params?: PostEndpoints.PutThreadDelete): Promise<void>;
203
+ PutSeriesSettings(params: PostEndpoints.PutSeriesSettings): Promise<void>;
204
+ PutTicket(params: PostEndpoints.PutTicket): Promise<Readonly<Responses.PutTicket>>;
205
+ PutTicketNote(params: PostEndpoints.PutTicketNote): Promise<void>;
206
+ PutUserSocialConnection(params: PostEndpoints.PutUserSocialConnection): Promise<void>;
207
+ PutUserSocialConnectionDelete(params: PostEndpoints.PutUserSocialConnectionDelete): Promise<void>;
208
+ PutUserSocialConnectionSsoExchange(params: PostEndpoints.PutUserSocialConnectionSsoExchange): Promise<void>;
209
+ PutUserUpdatePassword(params: PostEndpoints.PutUserUpdatePassword): Promise<void>;
210
+ PutUserUpdateEmail(params: PostEndpoints.PutUserUpdateEmail): Promise<Readonly<Responses.PutUserUpdateEmail>>;
211
+ PutUserUpdateName(params: PostEndpoints.PutUserUpdateName): Promise<Readonly<Responses.PutUserUpdateName>>;
212
+ PutUserDelete(params: PostEndpoints.PutUserDelete): Promise<void>;
213
+ PutCommentUpdate(params: PostEndpoints.PutCommentUpdate): Promise<void>;
214
+ PutCommentDelete(params: PostEndpoints.PutCommentDelete): Promise<void>;
215
+ PutCommentRestore(params: PostEndpoints.PutCommentRestore): Promise<void>;
216
+ PutThread(params: PostEndpoints.PutThread): Promise<Readonly<Responses.PutThread>>;
217
+ PutThreadLocked(params: PostEndpoints.PutThreadLocked): Promise<void>;
218
+ PutThreadSticky(params: PostEndpoints.PutThreadSticky): Promise<void>;
219
+ PutThreadDelete(params: PostEndpoints.PutThreadDelete): Promise<void>;
220
220
  }
@@ -15,12 +15,12 @@ const isInterfaceEmpty = (interfaceName, sourceFile) => {
15
15
  const isInterfaceAllOptional = (name, sourceFile) => {
16
16
  const iface = sourceFile.getInterface(name);
17
17
  if (iface) {
18
- return iface.getProperties().some(p => !p.hasQuestionToken());
18
+ return iface.getProperties().every(p => p.hasQuestionToken());
19
19
  }
20
20
  const typeNode = sourceFile.getTypeAliasOrThrow(name).getType();
21
21
  return typeNode
22
22
  .getProperties()
23
- .some(p => !p.isOptional());
23
+ .every(p => p.isOptional());
24
24
  };
25
25
  const baseClient = project.getSourceFileOrThrow('src/BaseClient.ts');
26
26
  const clientFile = project.createSourceFile('src/Client.ts', baseClient.getFullText(), { overwrite: true });
@@ -54,11 +54,11 @@ interface GetGameData_Base {
54
54
  /**
55
55
  * ID of the game.
56
56
  */
57
- gameId?: string;
57
+ gameId: string;
58
58
  /**
59
59
  * Game page URL.
60
60
  */
61
- gameUrl?: string;
61
+ gameUrl: string;
62
62
  }
63
63
  export type GetGameData = AtLeastOne<GetGameData_Base, 'gameId' | 'gameUrl'>;
64
64
  /**
@@ -70,11 +70,11 @@ interface GetGameSummary_Base {
70
70
  /**
71
71
  * ID of the game.
72
72
  */
73
- gameId?: string;
73
+ gameId: string;
74
74
  /**
75
75
  * Subpath URL of the game.
76
76
  */
77
- gameUrl?: string;
77
+ gameUrl: string;
78
78
  }
79
79
  export type GetGameSummary = AtLeastOne<GetGameSummary_Base, 'gameId' | 'gameUrl'>;
80
80
  /**
@@ -313,10 +313,17 @@ export interface GetArticleList {
313
313
  /**
314
314
  * Gets a specific site article.
315
315
  */
316
- export interface GetArticle {
317
- id?: string;
318
- slug?: string;
316
+ interface GetArticle_Base {
317
+ /**
318
+ * ID of the article to fetch.
319
+ */
320
+ id: string;
321
+ /**
322
+ * Slug of the article to fetch.
323
+ */
324
+ slug: string;
319
325
  }
326
+ export type GetArticle = AtLeastOne<GetArticle_Base>;
320
327
  /**
321
328
  * Gets a list of games.
322
329
  */
@@ -545,8 +552,9 @@ export interface GetCommentList {
545
552
  /**
546
553
  * The maximum amount of `Comment`s per page.
547
554
  *
548
- * @max 100
549
- * @default 100
555
+ * 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.
556
+ * @max 500
557
+ * @default 20
550
558
  */
551
559
  limit?: number;
552
560
  /**
@@ -1044,12 +1044,12 @@ export interface RunSettings {
1044
1044
  time?: RunTime;
1045
1045
  timeWithLoads?: RunTime;
1046
1046
  igt?: RunTime;
1047
- platformId: string;
1047
+ platformId?: string;
1048
1048
  emulator: boolean;
1049
- video: string;
1050
- comment: string;
1049
+ video?: string;
1050
+ comment?: string;
1051
1051
  date: number;
1052
- values: VariableValue[];
1052
+ values?: VariableValue[];
1053
1053
  }
1054
1054
  export interface Series {
1055
1055
  readonly id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "speedruncom.js",
3
- "version": "1.2.3",
3
+ "version": "1.2.5",
4
4
  "description": "WIP NodeJS module for Speedrun's version 2 API.",
5
5
  "type": "module",
6
6
  "author": {
@@ -18,13 +18,13 @@ const isInterfaceEmpty = (interfaceName: string, sourceFile: SourceFile) => {
18
18
  const isInterfaceAllOptional = (name: string, sourceFile: SourceFile) => {
19
19
  const iface = sourceFile.getInterface(name);
20
20
  if (iface) {
21
- return iface.getProperties().some(p => !p.hasQuestionToken());
21
+ return iface.getProperties().every(p => p.hasQuestionToken());
22
22
  }
23
23
 
24
24
  const typeNode = sourceFile.getTypeAliasOrThrow(name).getType();
25
25
  return typeNode
26
26
  .getProperties()
27
- .some(p => !p.isOptional());
27
+ .every(p => p.isOptional());
28
28
  };
29
29
 
30
30
  const baseClient = project.getSourceFileOrThrow('src/BaseClient.ts');
@@ -67,12 +67,12 @@ interface GetGameData_Base {
67
67
  /**
68
68
  * ID of the game.
69
69
  */
70
- gameId?: string;
70
+ gameId: string;
71
71
 
72
72
  /**
73
73
  * Game page URL.
74
74
  */
75
- gameUrl?: string;
75
+ gameUrl: string;
76
76
  }
77
77
 
78
78
  export type GetGameData = AtLeastOne<GetGameData_Base, 'gameId' | 'gameUrl'>;
@@ -87,12 +87,12 @@ interface GetGameSummary_Base {
87
87
  /**
88
88
  * ID of the game.
89
89
  */
90
- gameId?: string;
90
+ gameId: string;
91
91
 
92
92
  /**
93
93
  * Subpath URL of the game.
94
94
  */
95
- gameUrl?: string;
95
+ gameUrl: string;
96
96
  }
97
97
 
98
98
  export type GetGameSummary = AtLeastOne<GetGameSummary_Base, 'gameId' | 'gameUrl'>;
@@ -381,11 +381,21 @@ export interface GetArticleList {
381
381
  /**
382
382
  * Gets a specific site article.
383
383
  */
384
- export interface GetArticle {
385
- id?: string;
386
- slug?: string;
384
+ interface GetArticle_Base {
385
+
386
+ /**
387
+ * ID of the article to fetch.
388
+ */
389
+ id: string;
390
+
391
+ /**
392
+ * Slug of the article to fetch.
393
+ */
394
+ slug: string;
387
395
  }
388
396
 
397
+ export type GetArticle = AtLeastOne<GetArticle_Base>;
398
+
389
399
  /**
390
400
  * Gets a list of games.
391
401
  */
@@ -658,8 +668,9 @@ export interface GetCommentList {
658
668
  /**
659
669
  * The maximum amount of `Comment`s per page.
660
670
  *
661
- * @max 100
662
- * @default 100
671
+ * 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.
672
+ * @max 500
673
+ * @default 20
663
674
  */
664
675
  limit?: number;
665
676
 
package/src/interfaces.ts CHANGED
@@ -1231,12 +1231,12 @@ export interface RunSettings {
1231
1231
  time?: RunTime;
1232
1232
  timeWithLoads?: RunTime;
1233
1233
  igt?: RunTime;
1234
- platformId: string;
1234
+ platformId?: string;
1235
1235
  emulator: boolean;
1236
- video: string;
1237
- comment: string;
1236
+ video?: string;
1237
+ comment?: string;
1238
1238
  date: number;
1239
- values: VariableValue[];
1239
+ values?: VariableValue[];
1240
1240
  }
1241
1241
 
1242
1242
  export interface Series {