@retroachievements/api 1.5.3 → 2.1.0

package/dist/feed/getTopTenUsers.d.ts

@@ -4,7 +4,7 @@ import type { TopTenUsers } from "./models";
  * A call to this function will retrieve the current top ten users
  * on the site.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @example
@@ -15,8 +15,8 @@ import type { TopTenUsers } from "./models";
  * @returns An array containing the list of top ten users.
  * ```json
  * [
- *   { userName: "MockUser", totalPoints: 350000, totalRatioPoints: 995000 },
- *   { userName: "MockUser2", totalPoints: 345000, totalRatioPoints: 994000 },
+ *   { username: "MockUser", totalPoints: 350000, totalRatioPoints: 995000 },
+ *   { username: "MockUser2", totalPoints: 345000, totalRatioPoints: 994000 },
  *   // ...
  * ]
  * ```

package/dist/feed/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./getAchievementOfTheWeek";
 export * from "./getActiveClaims";
 export * from "./getClaims";
+export * from "./getRecentGameAwards";
 export * from "./getTopTenUsers";
 export * from "./models";

package/dist/feed/models/get-recent-game-awards-response.model.d.ts

@@ -0,0 +1,14 @@
+import type { AwardKind } from "../../utils/public";
+export interface GetRecentGameAwardsResponse {
+    Count: number;
+    Total: number;
+    Results: Array<{
+        User: string;
+        AwardKind: AwardKind;
+        AwardDate: string;
+        GameID: number;
+        GameTitle: string;
+        ConsoleID: number;
+        ConsoleName: string;
+    }>;
+}

package/dist/feed/models/index.d.ts

@@ -3,8 +3,10 @@ export * from "./claim-set-type.enum";
 export * from "./claim-status.enum";
 export * from "./claim-type.enum";
 export * from "./get-achievement-of-the-week-response.model";
+export * from "./get-recent-game-awards-response.model";
 export * from "./get-set-claims-response.model";
 export * from "./get-top-ten-users-response.model";
+export * from "./recent-game-awards.model";
 export * from "./set-claim.model";
 export * from "./top-ten-users.model";
 export * from "./top-ten-users-entity.model";

package/dist/feed/models/recent-game-awards.model.d.ts

@@ -0,0 +1,14 @@
+import type { AwardKind } from "../../utils/public";
+export interface RecentGameAwards {
+    count: number;
+    total: number;
+    results: Array<{
+        user: string;
+        awardKind: AwardKind;
+        awardDate: string;
+        gameId: number;
+        gameTitle: string;
+        consoleId: number;
+        consoleName: string;
+    }>;
+}

package/dist/feed/models/top-ten-users-entity.model.d.ts

@@ -1,5 +1,5 @@
 export interface TopTenUsersEntity {
-    userName: string;
+    username: string;
     totalPoints: number;
     totalRatioPoints: number;
 }

package/dist/game/getAchievementCount.d.ts

@@ -5,7 +5,7 @@ import type { AchievementCount } from "./models";
  * A call to this function will retrieve the list of
  * achievement IDs for a game, targeted by game ID.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.gameId The unique game ID. If you are unsure, open the

package/dist/game/getAchievementDistribution.d.ts

@@ -6,7 +6,7 @@ import type { AchievementDistributionFlags, GetAchievementDistributionResponse }
  * of the number of players who have earned a specific
  * number of achievements for a given game ID.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.gameId The unique game ID. If you are unsure, open the

package/dist/game/getGame.d.ts

@@ -5,7 +5,7 @@ import type { Game } from "./models";
  * A call to this function will retrieve basic metadata about
  * a game, targeted via its unique ID.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.gameId The unique game ID. If you are unsure, open the

package/dist/game/getGameExtended.d.ts

@@ -5,7 +5,7 @@ import type { GameExtended } from "./models";
  * A call to this function will retrieve extended metadata
  * about a game, targeted via its unique ID.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.gameId The unique game ID. If you are unsure, open the

package/dist/game/getGameRankAndScore.d.ts

@@ -7,7 +7,7 @@ import type { GameRankAndScoreEntity } from "./models";
  * points earners for a game. The game is targeted via
  * its unique ID.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.gameId The unique game ID. If you are unsure, open the

package/dist/game/getGameRating.d.ts

@@ -5,7 +5,7 @@ import type { GameRating } from "./models";
  * A call to this function will retrieve metadata about
  * how users have rated the game and its set.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.gameId The unique game ID. If you are unsure, open the

package/dist/ticket/getTicketData.d.ts

@@ -8,7 +8,7 @@ import type { AchievementTicketStats, GameTicketStats, MostTicketedGames, Recent
  * A call to this function will retrieve ticket metadata information
  * about a single achievement ticket, targeted by its ticket ID.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.ticketId The ID of the ticket to get information about.
@@ -30,7 +30,7 @@ export declare function getTicketData(authorization: AuthObject, payload: {
  * A call to this function will retrieve ticket metadata information
  * about the latest opened achievement tickets on RetroAchievements.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.count Optional. Defaults to 10. Max is 100.
@@ -54,7 +54,7 @@ export declare function getTicketData(authorization: AuthObject, payload?: Parti
  * A call to this function will retrieve the games on the site with
  * the highest count of opened achievement tickets.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.count Optional. Defaults to 10. Max is 100.
@@ -82,31 +82,31 @@ export declare function getTicketData(authorization: AuthObject, payload: {
  * A call to this function will retrieve an achievement developer's
  * ticket stats, targeted by that developer's username.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The developer's account username to retrieve
+ * @param payload.username The developer's account username to retrieve
  * ticket stats for.
  *
  * @example
  * ```
  * const ticketData = await getTicketData(
  *   authorization,
- *   { userName: "xelnia" }
+ *   { username: "xelnia" }
  * );
  * ```
  *
  * @returns An achievement developer's ticket stats.
  */
 export declare function getTicketData(authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
 }): Promise<UserTicketStats>;
 /**
  * A call to this function will retrieve a game's ticket stats, targeted
  * by the game's ID. If you are unsure of a game's ID, visit its page
  * on the RetroAchievements website and copy the number at the end of the URL.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.gameId The game ID to fetch ticket stats for.
@@ -138,7 +138,7 @@ export declare function getTicketData(authorization: AuthObject, payload: {
  * of an achievement's ID, open its page on the RetroAchievements
  * website and copy the number at the end of the URL.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.achievementId The ID of the achievement to fetch ticket

package/dist/user/getAchievementsEarnedBetween.d.ts

@@ -4,10 +4,10 @@ import type { DatedUserAchievement } from "./models";
  * A call to this function will retrieve a list of achievements
  * earned by a given user between two provided dates.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the
+ * @param payload.username The user for which to retrieve the
  * list of achievements for.
  *
  * @param payload.fromDate A Date object specifying when
@@ -21,7 +21,7 @@ import type { DatedUserAchievement } from "./models";
  * const achievementsEarnedBetween = await getAchievementsEarnedBetween(
  *   authorization,
  *   {
- *     userName: "xelnia",
+ *     username: "xelnia",
  *     fromDate: new Date("2022-10-12"),
  *     toDate: new Date("2022-10-13")
  *   }
@@ -54,7 +54,7 @@ import type { DatedUserAchievement } from "./models";
  * ```
  */
 export declare const getAchievementsEarnedBetween: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
     fromDate: Date;
     toDate: Date;
 }) => Promise<DatedUserAchievement[]>;

package/dist/user/getAchievementsEarnedOnDay.d.ts

@@ -4,10 +4,10 @@ import type { DatedUserAchievement } from "./models";
  * A call to this function will retrieve a list of achievements
  * earned by a given user on a specified date.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the
+ * @param payload.username The user for which to retrieve the
  * list of achievements for.
  *
  * @param payload.fromDate A Date object specifying when
@@ -21,7 +21,7 @@ import type { DatedUserAchievement } from "./models";
  * const achievementsEarnedOnDay = await getAchievementsEarnedOnDay(
  *   authorization,
  *   {
- *     userName: "xelnia",
+ *     username: "xelnia",
  *     onDate: new Date("2022-10-13")
  *   }
  * );
@@ -53,6 +53,6 @@ import type { DatedUserAchievement } from "./models";
  * ```
  */
 export declare const getAchievementsEarnedOnDay: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
     onDate: Date;
 }) => Promise<DatedUserAchievement[]>;

package/dist/user/getGameInfoAndUserProgress.d.ts

@@ -6,7 +6,7 @@ import type { GameInfoAndUserProgress } from "./models";
  * about a game, in addition to a user's progress about a game.
  * This is targeted via a game's unique ID and a given username.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.gameId The unique game ID. If you are unsure, open the
@@ -14,14 +14,17 @@ import type { GameInfoAndUserProgress } from "./models";
  * URL is https://retroachievements.org/game/14402. We can see from the
  * URL that the game ID is "14402".
  *
- * @param payload.userName The user for which to retrieve the
+ * @param payload.username The user for which to retrieve the
  * game progress for.
  *
+ * @param payload.shouldIncludeHighestAwardMetadata Include a "HighestAwardKind"
+ * and a "HighestAwardDate" for the given user and game ID.
+ *
  * @example
  * ```
  * const gameInfoAndUserProgress = await getGameInfoAndUserProgress(
  *   authorization,
- *   { gameId: 14402, userName: "wv_pinball" }
+ *   { gameId: 14402, username: "wv_pinball" }
  * );
  * ```
  *
@@ -41,7 +44,7 @@ import type { GameInfoAndUserProgress } from "./models";
  *   publisher: "Activision",
  *   developer: "David Crane",
  *   genre: "Racing",
- *   released: 1980,
+ *   released: "1980",
  *   isFinal: false,
  *   consoleName: "Atari 2600",
  *   richPresencePatch: "2b92fa1bf9635c303b3b7f8feea3ed3c",
@@ -77,5 +80,6 @@ import type { GameInfoAndUserProgress } from "./models";
  */
 export declare const getGameInfoAndUserProgress: (authorization: AuthObject, payload: {
     gameId: ID;
-    userName: string;
+    username: string;
+    shouldIncludeHighestAwardMetadata?: boolean;
 }) => Promise<GameInfoAndUserProgress>;

package/dist/user/getUserAwards.d.ts

@@ -4,16 +4,16 @@ import type { UserAwards } from "./models";
  * A call to this function will retrieve metadata about the target user's
  * site awards, via their username.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the site awards for.
+ * @param payload.username The user for which to retrieve the site awards for.
  *
  * @example
  * ```
  * const userAwards = await getUserAwards(
  *   authorization,
- *   { userName: "xelnia" }
+ *   { username: "xelnia" }
  * )
  * ```
  *
@@ -45,5 +45,5 @@ import type { UserAwards } from "./models";
  * ```
  */
 export declare const getUserAwards: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
 }) => Promise<UserAwards>;

package/dist/user/getUserClaims.d.ts

@@ -5,17 +5,17 @@ import type { UserClaims } from "./models";
  * achievement set claims made over the lifetime of a given
  * user, targeted by their username.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the historical
+ * @param payload.username The user for which to retrieve the historical
  * achievement set claims list for.
  *
  * @example
  * ```
  * const userClaims = await getUserClaims(
  *   authorization,
- *   { userName: "Jamiras" }
+ *   { username: "Jamiras" }
  * );
  * ```
  *
@@ -23,5 +23,5 @@ import type { UserClaims } from "./models";
  * made over the lifetime of the given user.
  */
 export declare const getUserClaims: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
 }) => Promise<UserClaims>;

package/dist/user/getUserCompletedGames.d.ts

@@ -7,17 +7,17 @@ import type { UserCompletedGames } from "./models";
  * one for the hardcore completion. These are designated by
  * the `hardcoreMode` property on each completion object.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the
+ * @param payload.username The user for which to retrieve the
  * completion metadata for.
  *
  * @example
  * ```
  * const userCompletedGames = await getUserCompletedGames(
  *   authorization,
- *   { userName: "xelnia" }
+ *   { username: "xelnia" }
  * );
  * ```
  *
@@ -52,5 +52,5 @@ import type { UserCompletedGames } from "./models";
  * ```
  */
 export declare const getUserCompletedGames: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
 }) => Promise<UserCompletedGames>;

package/dist/user/getUserCompletionProgress.d.ts

@@ -4,10 +4,10 @@ import type { UserCompletionProgress } from "./models";
  * A call to this function will retrieve a given user's completion
  * progress, targeted by their username.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the progress for.
+ * @param payload.username The user for which to retrieve the progress for.
  *
  * @param payload.offset Defaults to 0. The number of entries to skip.
  *
@@ -17,7 +17,7 @@ import type { UserCompletionProgress } from "./models";
  * ```
  * const userCompletionProgress = await getUserCompletionProgress(
  *   authorization,
- *   { userName: "xelnia" }
+ *   { username: "xelnia" }
  * );
  * ```
  *
@@ -45,7 +45,7 @@ import type { UserCompletionProgress } from "./models";
  * ```
  */
 export declare const getUserCompletionProgress: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
     offset?: number;
     count?: number;
 }) => Promise<UserCompletionProgress>;

package/dist/user/getUserGameRankAndScore.d.ts

@@ -6,7 +6,7 @@ import type { UserGameRankAndScore } from "./models";
  * how a particular user has performed/ranked on a particular
  * game, targeted by game ID.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
  * @param payload.gameId The unique game ID. If you are unsure, open the
@@ -14,14 +14,14 @@ import type { UserGameRankAndScore } from "./models";
  * URL is https://retroachievements.org/game/14402. We can see from the
  * URL that the game ID is "14402".
  *
- * @param payload.userName The user for which to retrieve the
+ * @param payload.username The user for which to retrieve the
  * game ranking metadata for.
  *
  * @example
  * ```
  * const userGameRankAndScore = await getUserGameRankAndScore(
  *   authorization,
- *   { gameId: 14402, userName: "xelnia" }
+ *   { gameId: 14402, username: "xelnia" }
  * );
  * ```
  *
@@ -41,5 +41,5 @@ import type { UserGameRankAndScore } from "./models";
  */
 export declare const getUserGameRankAndScore: (authorization: AuthObject, payload: {
     gameId: ID;
-    userName: string;
+    username: string;
 }) => Promise<UserGameRankAndScore>;

package/dist/user/getUserPoints.d.ts

@@ -4,16 +4,16 @@ import type { UserPoints } from "./models";
  * A call to this function will retrieve a given user's hardcore
  * and softcore points.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the point totals for.
+ * @param payload.username The user for which to retrieve the point totals for.
  *
  * @example
  * ```
  * const userPoints = await getUserPoints(
  *   authorization,
- *   { userName: "xelnia" }
+ *   { username: "xelnia" }
  * );
  * ```
  *
@@ -26,5 +26,5 @@ import type { UserPoints } from "./models";
  * ```
  */
 export declare const getUserPoints: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
 }) => Promise<UserPoints>;

package/dist/user/getUserProfile.d.ts

@@ -4,21 +4,21 @@ import type { UserProfile } from "./models";
  * A call to this function will retrieve summary information about
  * a given user, targeted by username.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the summary for.
+ * @param payload.username The user for which to retrieve the summary for.
  *
  * @example
  * ```
  * const userSummary = await getUserProfile(
  *   authorization,
- *   { userName: "xelnia" }
+ *   { username: "xelnia" }
  * );
  * ```
  *
  * @returns An object containing profile summary metadata about a target user.
  */
 export declare const getUserProfile: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
 }) => Promise<UserProfile>;

package/dist/user/getUserProgress.d.ts

@@ -5,10 +5,10 @@ import type { UserProgress } from "./models";
  * A call to this function will retrieve a given user's
  * progress on a given list of games, targeted by game ID.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the progress for.
+ * @param payload.username The user for which to retrieve the progress for.
  *
  * @param payload.gameIds An array of RetroAchievements game IDs. If you aren't
  * sure of the game ID, visit the game's page on the website and copy the number
@@ -18,7 +18,7 @@ import type { UserProgress } from "./models";
  * ```
  * const userProgress = await getUserProgress(
  *   authorization,
- *   { userName: "xelnia", gameIds: [1, 14402] }
+ *   { username: "xelnia", gameIds: [1, 14402] }
  * );
  * ```
  *
@@ -45,6 +45,6 @@ import type { UserProgress } from "./models";
  * ```
  */
 export declare const getUserProgress: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
     gameIds: ID[];
 }) => Promise<UserProgress>;

package/dist/user/getUserRecentAchievements.d.ts

@@ -5,10 +5,10 @@ import type { UserRecentAchievement } from "./models";
  * recently earned achievements, via their username. By default, it
  * fetches achievements earned in the last hour.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the recent achievements for.
+ * @param payload.username The user for which to retrieve the recent achievements for.
  *
  * @param payload.recentMinutes Optional. Defaults to 60. How many minutes
  * back to fetch for the given user.
@@ -17,7 +17,7 @@ import type { UserRecentAchievement } from "./models";
  * ```
  * const userRecentAchievements = await getUserRecentAchievements(
  *   authorization,
- *   { userName: "xelnia" }
+ *   { username: "xelnia" }
  * );
  * ```
  *
@@ -44,6 +44,6 @@ import type { UserRecentAchievement } from "./models";
  * ```
  */
 export declare const getUserRecentAchievements: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
     recentMinutes?: number;
 }) => Promise<UserRecentAchievement[]>;

package/dist/user/getUserRecentlyPlayedGames.d.ts

@@ -4,10 +4,10 @@ import type { UserRecentlyPlayedGames } from "./models";
  * A call to this function will retrieve a list of a target user's
  * recently played games, via their username.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the summary for.
+ * @param payload.username The user for which to retrieve the summary for.
  *
  * @param payload.count Optional. Defaults to 10. Max is 50. How many
  * recently played games for the user to retrieve.
@@ -19,7 +19,7 @@ import type { UserRecentlyPlayedGames } from "./models";
  * ```
  * const userRecentlyPlayedGames = await getUserRecentlyPlayedGames(
  *   authorization,
- *   { userName: "xelnia" }
+ *   { username: "xelnia" }
  * );
  * ```
  *
@@ -44,7 +44,7 @@ import type { UserRecentlyPlayedGames } from "./models";
  * ```
  */
 export declare const getUserRecentlyPlayedGames: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
     offset?: number;
     count?: number;
 }) => Promise<UserRecentlyPlayedGames>;

package/dist/user/getUserSummary.d.ts

@@ -4,10 +4,10 @@ import type { UserSummary } from "./models";
  * A call to this function will retrieve summary information about
  * a given user, targeted by username.
  *
- * @param authorization An object containing your userName and webApiKey.
+ * @param authorization An object containing your username and webApiKey.
  * This can be constructed with `buildAuthorization()`.
  *
- * @param payload.userName The user for which to retrieve the summary for.
+ * @param payload.username The user for which to retrieve the summary for.
  *
  * @param payload.recentGamesCount Optional. The number of recent games to return.
  * This defaults to 0.
@@ -19,14 +19,14 @@ import type { UserSummary } from "./models";
  * ```
  * const userSummary = await getUserSummary(
  *   authorization,
- *   { userName: "xelnia" }
+ *   { username: "xelnia" }
  * );
  * ```
  *
  * @returns An object containing summary metadata about a target user.
  */
 export declare const getUserSummary: (authorization: AuthObject, payload: {
-    userName: string;
+    username: string;
     recentGamesCount?: number;
     recentAchievementsCount?: number;
 }) => Promise<UserSummary>;