speedruncom.js 1.2.6 → 1.2.8

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.
Files changed (5) hide show
  1. package/dist/endpoints/endpoints.get.d.ts +4 -46
  2. package/dist/endpoints/endpoints.post.d.ts +4 -0
  3. package/package.json +1 -1
  4. package/src/endpoints/endpoints.get.ts +5 -56
  5. package/src/endpoints/endpoints.post.ts +6 -0
package/dist/endpoints/endpoints.get.d.ts CHANGED
@@ -81,52 +81,10 @@ export type GetGameSummary = AtLeastOne<GetGameSummary_Base, 'gameId' | 'gameUrl
81
81
  * Gets the world record history of a game leaderboard.
82
82
  */
83
83
  export interface GetGameRecordHistory {
84
- params?: {
85
- /**
86
- * ID of the leaderboard's category.
87
- */
88
- categoryId?: string;
89
- /**
90
- * `EmulatorFilter` to filter the leaderboard by.
91
- */
92
- emulator?: Enums.EmulatorFilter;
93
- /**
94
- * ID of the game. When exempted, the lists will be empty arrays.
95
- */
96
- gameId?: string;
97
- /**
98
- * `ObsoleteFilter` to filter the leaderboard by.
99
- */
100
- obsolete?: Enums.ObsoleteFilter;
101
- /**
102
- * IDs of platforms to filter the leaderboard by.
103
- *
104
- * All Platforms can be fetched with `GetPlatformList`.
105
- */
106
- platformIds?: string[];
107
- /**
108
- * IDs of regions to filter the leaderboard by.
109
- *
110
- * All Regions can be fetched with `GetStaticData.regionList`.
111
- */
112
- regionIds?: string[];
113
- /**
114
- * `TimingMethod` to filter the leaderboard by.
115
- */
116
- timer?: Enums.TimingMethod;
117
- /**
118
- * `RunStatus` to filter the leaderboard by.
119
- */
120
- verified?: Enums.RunStatus;
121
- /**
122
- * `VariableValues` to filter the leaderboard by.
123
- */
124
- values?: Interfaces.VariableValues[];
125
- /**
126
- * `VideoState` of runs to filter the leaderboard by.
127
- */
128
- video?: Enums.VideoState;
129
- };
84
+ /**
85
+ * Leaderboard to fetch record history of.
86
+ */
87
+ params?: Interfaces.LeaderboardParams;
130
88
  /**
131
89
  * The limit of Runs per page.
132
90
  *
package/dist/endpoints/endpoints.post.d.ts CHANGED
@@ -384,6 +384,10 @@ export interface PutResource {
384
384
  * Updates a resource item.
385
385
  */
386
386
  export interface PutResourceUpdate {
387
+ /**
388
+ * ID of the resource to update.
389
+ */
390
+ resourceId: string;
387
391
  gameId: string;
388
392
  /**
389
393
  * Manager ID
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "speedruncom.js",
3
- "version": "1.2.6",
3
+ "version": "1.2.8",
4
4
  "description": "WIP NodeJS module for Speedrun's version 2 API.",
5
5
  "type": "module",
6
6
  "author": {
package/src/endpoints/endpoints.get.ts CHANGED
@@ -101,62 +101,11 @@ export type GetGameSummary = AtLeastOne<GetGameSummary_Base, 'gameId' | 'gameUrl
101
101
  * Gets the world record history of a game leaderboard.
102
102
  */
103
103
  export interface GetGameRecordHistory {
104
- params?: {
105
-
106
- /**
107
- * ID of the leaderboard's category.
108
- */
109
- categoryId?: string;
110
-
111
- /**
112
- * `EmulatorFilter` to filter the leaderboard by.
113
- */
114
- emulator?: Enums.EmulatorFilter;
115
-
116
- /**
117
- * ID of the game. When exempted, the lists will be empty arrays.
118
- */
119
- gameId?: string;
120
-
121
- /**
122
- * `ObsoleteFilter` to filter the leaderboard by.
123
- */
124
- obsolete?: Enums.ObsoleteFilter;
125
-
126
- /**
127
- * IDs of platforms to filter the leaderboard by.
128
- *
129
- * All Platforms can be fetched with `GetPlatformList`.
130
- */
131
- platformIds?: string[];
132
-
133
- /**
134
- * IDs of regions to filter the leaderboard by.
135
- *
136
- * All Regions can be fetched with `GetStaticData.regionList`.
137
- */
138
- regionIds?: string[];
139
-
140
- /**
141
- * `TimingMethod` to filter the leaderboard by.
142
- */
143
- timer?: Enums.TimingMethod;
144
-
145
- /**
146
- * `RunStatus` to filter the leaderboard by.
147
- */
148
- verified?: Enums.RunStatus,
149
-
150
- /**
151
- * `VariableValues` to filter the leaderboard by.
152
- */
153
- values?: Interfaces.VariableValues[];
154
-
155
- /**
156
- * `VideoState` of runs to filter the leaderboard by.
157
- */
158
- video?: Enums.VideoState;
159
- }
104
+
105
+ /**
106
+ * Leaderboard to fetch record history of.
107
+ */
108
+ params?: Interfaces.LeaderboardParams;
160
109
 
161
110
  /**
162
111
  * The limit of Runs per page.
package/src/endpoints/endpoints.post.ts CHANGED
@@ -463,6 +463,12 @@ export interface PutResource {
463
463
  */
464
464
  export interface PutResourceUpdate {
465
465
  // check all check base64 encoding of content probably a `resourceId`
466
+
467
+ /**
468
+ * ID of the resource to update.
469
+ */
470
+ resourceId: string;
471
+
466
472
  gameId: string;
467
473
 
468
474
  /**