speedruncom.js 1.2.7 → 1.2.9

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.
@@ -172,6 +172,10 @@ export interface GetLatestLeaderboard {
172
172
  * @default 25
173
173
  */
174
174
  limit?: number;
175
+ /**
176
+ * The run list page, in relation to `limit`.
177
+ */
178
+ page?: number;
175
179
  }
176
180
  /**
177
181
  * Gets a single run.
@@ -309,6 +313,10 @@ export interface GetGameList {
309
313
  * @default 500
310
314
  */
311
315
  limit?: number;
316
+ /**
317
+ * The game list page, in relation to `limit`.
318
+ */
319
+ page?: number;
312
320
  }
313
321
  /**
314
322
  * Gets a list of Platforms in the site.
@@ -336,6 +344,10 @@ export interface GetSeriesList {
336
344
  * @default 500
337
345
  */
338
346
  limit?: number;
347
+ /**
348
+ * The leaderboard page, in relation to `limit`.
349
+ */
350
+ page?: number;
339
351
  }
340
352
  /**
341
353
  * Gets most information pertinent to a series.
@@ -356,10 +368,6 @@ export interface GetGameLevelSummary {
356
368
  * When not included, `runList[]` will be empty.
357
369
  */
358
370
  params?: Interfaces.LeaderboardParams;
359
- /**
360
- * The leaderboard page, in relation to `limit`.
361
- */
362
- page?: number;
363
371
  /**
364
372
  * The limit of Runs per page.
365
373
  *
@@ -367,6 +375,10 @@ export interface GetGameLevelSummary {
367
375
  * @default Unknown - likely around 99999.
368
376
  */
369
377
  limit?: number;
378
+ /**
379
+ * The leaderboard page, in relation to `limit`.
380
+ */
381
+ page?: number;
370
382
  }
371
383
  /**
372
384
  * Gets a random Game.
@@ -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
@@ -424,9 +428,9 @@ export interface GetModerationRuns {
424
428
  search?: string;
425
429
  verified?: Enums.RunStatus;
426
430
  verifiedById?: string;
427
- ideoState?: Enums.VideoState;
428
- page?: number;
431
+ videoState?: Enums.VideoState;
429
432
  limit?: number;
433
+ page?: number;
430
434
  }
431
435
  /**
432
436
  * Assigns a verifier to a run.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "speedruncom.js",
3
- "version": "1.2.7",
3
+ "version": "1.2.9",
4
4
  "description": "WIP NodeJS module for Speedrun's version 2 API.",
5
5
  "type": "module",
6
6
  "author": {
@@ -210,6 +210,11 @@ export interface GetLatestLeaderboard {
210
210
  * @default 25
211
211
  */
212
212
  limit?: number;
213
+
214
+ /**
215
+ * The run list page, in relation to `limit`.
216
+ */
217
+ page?: number;
213
218
  }
214
219
 
215
220
  /**
@@ -377,6 +382,11 @@ export interface GetGameList {
377
382
  * @default 500
378
383
  */
379
384
  limit?: number;
385
+
386
+ /**
387
+ * The game list page, in relation to `limit`.
388
+ */
389
+ page?: number;
380
390
  }
381
391
 
382
392
  /**
@@ -408,6 +418,11 @@ export interface GetSeriesList {
408
418
  * @default 500
409
419
  */
410
420
  limit?: number;
421
+
422
+ /**
423
+ * The leaderboard page, in relation to `limit`.
424
+ */
425
+ page?: number;
411
426
  }
412
427
 
413
428
  /**
@@ -433,11 +448,6 @@ export interface GetGameLevelSummary {
433
448
  */
434
449
  params?: Interfaces.LeaderboardParams;
435
450
 
436
- /**
437
- * The leaderboard page, in relation to `limit`.
438
- */
439
- page?: number;
440
-
441
451
  /**
442
452
  * The limit of Runs per page.
443
453
  *
@@ -445,6 +455,11 @@ export interface GetGameLevelSummary {
445
455
  * @default Unknown - likely around 99999.
446
456
  */
447
457
  limit?: number;
458
+
459
+ /**
460
+ * The leaderboard page, in relation to `limit`.
461
+ */
462
+ page?: number;
448
463
  }
449
464
 
450
465
  /**
@@ -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
  /**
@@ -508,9 +514,9 @@ export interface GetModerationRuns {
508
514
  search?: string;
509
515
  verified?: Enums.RunStatus;
510
516
  verifiedById?: string;
511
- ideoState?: Enums.VideoState;
512
- page?: number;
517
+ videoState?: Enums.VideoState;
513
518
  limit?: number;
519
+ page?: number;
514
520
  }
515
521
 
516
522
  /**