@retroachievements/api 1.2.1 → 1.3.0

package/dist/ticket/getTicketData.d.ts

@@ -1,159 +1,159 @@
-import type { ID } from "../utils/internal";
-import type { AuthObject } from "../utils/public";
-import type { AchievementTicketStats, GameTicketStats, MostTicketedGames, RecentTickets, TicketEntity, UserTicketStats } from "./models";
-/**
- * BEGIN: Function overload definitions
- */
-/**
- * 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.
- * This can be constructed with `buildAuthorization()`.
- *
- * @param payload.ticketId The ID of the ticket to get information about.
- *
- * @example
- * ```
- * const ticketData = await getTicketData(
- *   authorization,
- *   { ticketId: 12345 }
- * );
- * ```
- *
- * @returns An object containing metadata about a target ticket.
- */
-export declare function getTicketData(authorization: AuthObject, payload: {
-    ticketId: ID;
-}): Promise<TicketEntity>;
-/**
- * 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.
- * This can be constructed with `buildAuthorization()`.
- *
- * @param payload.count Optional. Defaults to 10. Max is 100.
- * How many tickets to retrieve.
- *
- * @param payload.offset Optional. Defaults to 0.
- * Number of tickets to skip. This can be used for pagination.
- *
- * @example
- * ```
- * const ticketData = await getTicketData(authorization);
- * ```
- *
- * @returns A list of the most recently opened tickets on the site.
- */
-export declare function getTicketData(authorization: AuthObject, payload?: Partial<{
-    offset: number;
-    count: number;
-}>): Promise<RecentTickets>;
-/**
- * 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.
- * This can be constructed with `buildAuthorization()`.
- *
- * @param payload.count Optional. Defaults to 10. Max is 100.
- * How many ticketed games to retrieve.
- *
- * @param payload.offset Optional. Defaults to 0.
- * Number of games to skip. This can be used for pagination.
- *
- * @example
- * ```
- * const ticketData = await getTicketData(
- *   authorization,
- *   { isGettingMostTicketedGames: true }
- * );
- * ```
- *
- * @returns A list of the most recently opened tickets on the site.
- */
-export declare function getTicketData(authorization: AuthObject, payload: {
-    isGettingMostTicketedGames: true;
-    offset?: number;
-    count?: number;
-}): Promise<MostTicketedGames>;
-/**
- * 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.
- * This can be constructed with `buildAuthorization()`.
- *
- * @param payload.userName The developer's account username to retrieve
- * ticket stats for.
- *
- * @example
- * ```
- * const ticketData = await getTicketData(
- *   authorization,
- *   { userName: "xelnia" }
- * );
- * ```
- *
- * @returns An achievement developer's ticket stats.
- */
-export declare function getTicketData(authorization: AuthObject, payload: {
-    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.
- * This can be constructed with `buildAuthorization()`.
- *
- * @param payload.gameId The game ID to fetch ticket stats for.
- *
- * @param payload.isGettingTicketsForUnofficialAchievements Optional. Fetch stats
- * for unofficial/non-core achievements that have tickets.
- *
- * @param payload.shouldReturnTicketsList Optional. If true, not only fetches a
- * game's ticket stats, but also returns a list of tickets for the game.
- *
- * @example
- * ```
- * const ticketData = await getTicketData(
- *   authorization,
- *   { gameId: 14_402 }
- * );
- * ```
- *
- * @returns A game's ticket stats, potentially also including the ticket list.
- */
-export declare function getTicketData(authorization: AuthObject, payload: {
-    gameId: ID;
-    isGettingTicketsForUnofficialAchievements?: true;
-    shouldReturnTicketsList?: true;
-}): Promise<GameTicketStats>;
-/**
- * A call to this function will retrieve the an achievement's
- * ticket stats, targeted by the achievement's ID. If you are unsure
- * 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.
- * This can be constructed with `buildAuthorization()`.
- *
- * @param payload.achievementId The ID of the achievement to fetch ticket
- * stats for.
- *
- * @example
- * ```
- * const ticketData = await getTicketData(
- *   authorization,
- *   { achievementId: 12345 }
- * );
- * ```
- *
- * @returns An achievement developer's ticket stats.
- */
-export declare function getTicketData(authorization: AuthObject, payload: {
-    achievementId: ID;
-}): Promise<AchievementTicketStats>;
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { AchievementTicketStats, GameTicketStats, MostTicketedGames, RecentTickets, TicketEntity, UserTicketStats } from "./models";
+/**
+ * BEGIN: Function overload definitions
+ */
+/**
+ * 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.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.ticketId The ID of the ticket to get information about.
+ *
+ * @example
+ * ```
+ * const ticketData = await getTicketData(
+ *   authorization,
+ *   { ticketId: 12345 }
+ * );
+ * ```
+ *
+ * @returns An object containing metadata about a target ticket.
+ */
+export declare function getTicketData(authorization: AuthObject, payload: {
+    ticketId: ID;
+}): Promise<TicketEntity>;
+/**
+ * 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.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.count Optional. Defaults to 10. Max is 100.
+ * How many tickets to retrieve.
+ *
+ * @param payload.offset Optional. Defaults to 0.
+ * Number of tickets to skip. This can be used for pagination.
+ *
+ * @example
+ * ```
+ * const ticketData = await getTicketData(authorization);
+ * ```
+ *
+ * @returns A list of the most recently opened tickets on the site.
+ */
+export declare function getTicketData(authorization: AuthObject, payload?: Partial<{
+    offset: number;
+    count: number;
+}>): Promise<RecentTickets>;
+/**
+ * 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.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.count Optional. Defaults to 10. Max is 100.
+ * How many ticketed games to retrieve.
+ *
+ * @param payload.offset Optional. Defaults to 0.
+ * Number of games to skip. This can be used for pagination.
+ *
+ * @example
+ * ```
+ * const ticketData = await getTicketData(
+ *   authorization,
+ *   { isGettingMostTicketedGames: true }
+ * );
+ * ```
+ *
+ * @returns A list of the most recently opened tickets on the site.
+ */
+export declare function getTicketData(authorization: AuthObject, payload: {
+    isGettingMostTicketedGames: true;
+    offset?: number;
+    count?: number;
+}): Promise<MostTicketedGames>;
+/**
+ * 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.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.userName The developer's account username to retrieve
+ * ticket stats for.
+ *
+ * @example
+ * ```
+ * const ticketData = await getTicketData(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns An achievement developer's ticket stats.
+ */
+export declare function getTicketData(authorization: AuthObject, payload: {
+    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.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.gameId The game ID to fetch ticket stats for.
+ *
+ * @param payload.isGettingTicketsForUnofficialAchievements Optional. Fetch stats
+ * for unofficial/non-core achievements that have tickets.
+ *
+ * @param payload.shouldReturnTicketsList Optional. If true, not only fetches a
+ * game's ticket stats, but also returns a list of tickets for the game.
+ *
+ * @example
+ * ```
+ * const ticketData = await getTicketData(
+ *   authorization,
+ *   { gameId: 14_402 }
+ * );
+ * ```
+ *
+ * @returns A game's ticket stats, potentially also including the ticket list.
+ */
+export declare function getTicketData(authorization: AuthObject, payload: {
+    gameId: ID;
+    isGettingTicketsForUnofficialAchievements?: true;
+    shouldReturnTicketsList?: true;
+}): Promise<GameTicketStats>;
+/**
+ * A call to this function will retrieve the an achievement's
+ * ticket stats, targeted by the achievement's ID. If you are unsure
+ * 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.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.achievementId The ID of the achievement to fetch ticket
+ * stats for.
+ *
+ * @example
+ * ```
+ * const ticketData = await getTicketData(
+ *   authorization,
+ *   { achievementId: 12345 }
+ * );
+ * ```
+ *
+ * @returns An achievement developer's ticket stats.
+ */
+export declare function getTicketData(authorization: AuthObject, payload: {
+    achievementId: ID;
+}): Promise<AchievementTicketStats>;

package/dist/ticket/getTicketData.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/ticket/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./getTicketData";
-export * from "./models";
+export * from "./getTicketData";
+export * from "./models";

package/dist/ticket/models/achievement-ticket-stats-response.model.d.ts

@@ -1,7 +1,7 @@
-export interface AchievementTicketStatsResponse {
-    AchievementID: number;
-    AchievementTitle: string;
-    AchievementDescription: string;
-    URL: string;
-    OpenTickets: number;
-}
+export interface AchievementTicketStatsResponse {
+    AchievementID: number;
+    AchievementTitle: string;
+    AchievementDescription: string;
+    URL: string;
+    OpenTickets: number;
+}

package/dist/ticket/models/achievement-ticket-stats.model.d.ts

@@ -1,7 +1,7 @@
-export interface AchievementTicketStats {
-    achievementId: number;
-    achievementTitle: string;
-    achievementDescription: string;
-    url: string;
-    openTickets: number;
-}
+export interface AchievementTicketStats {
+    achievementId: number;
+    achievementTitle: string;
+    achievementDescription: string;
+    url: string;
+    openTickets: number;
+}

package/dist/ticket/models/game-ticket-stats.model.d.ts

@@ -1,9 +1,9 @@
-import type { TicketEntity } from "./ticket-entity.model";
-export interface GameTicketStats {
-    gameId: number;
-    gameTitle: string;
-    consoleName: string;
-    openTickets: number;
-    url: string;
-    tickets?: TicketEntity[];
-}
+import type { TicketEntity } from "./ticket-entity.model";
+export interface GameTicketStats {
+    gameId: number;
+    gameTitle: string;
+    consoleName: string;
+    openTickets: number;
+    url: string;
+    tickets?: TicketEntity[];
+}

package/dist/ticket/models/game-tickets-response.model.d.ts

@@ -1,7 +1,7 @@
-export interface GameTicketsResponse {
-    GameID: number;
-    GameTitle: string;
-    ConsoleName: string;
-    OpenTickets: number;
-    URL: string;
-}
+export interface GameTicketsResponse {
+    GameID: number;
+    GameTitle: string;
+    ConsoleName: string;
+    OpenTickets: number;
+    URL: string;
+}

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

@@ -1,12 +1,12 @@
-export * from "./achievement-ticket-stats.model";
-export * from "./achievement-ticket-stats-response.model";
-export * from "./game-ticket-stats.model";
-export * from "./game-tickets-response.model";
-export * from "./most-ticketed-games.model";
-export * from "./most-ticketed-games-response.model";
-export * from "./recent-tickets.model";
-export * from "./recent-tickets-response.model";
-export * from "./response-ticket-entity.model";
-export * from "./ticket-entity.model";
-export * from "./tickets-by-user-response.model";
-export * from "./user-ticket-stats.model";
+export * from "./achievement-ticket-stats.model";
+export * from "./achievement-ticket-stats-response.model";
+export * from "./game-ticket-stats.model";
+export * from "./game-tickets-response.model";
+export * from "./most-ticketed-games.model";
+export * from "./most-ticketed-games-response.model";
+export * from "./recent-tickets.model";
+export * from "./recent-tickets-response.model";
+export * from "./response-ticket-entity.model";
+export * from "./ticket-entity.model";
+export * from "./tickets-by-user-response.model";
+export * from "./user-ticket-stats.model";

package/dist/ticket/models/most-ticketed-games-response.model.d.ts

@@ -1,12 +1,12 @@
-interface ReportedGameEntity {
-    GameID: string;
-    GameTitle: string;
-    GameIcon: string;
-    Console: string;
-    OpenTickets: string;
-}
-export interface MostTicketedGamesResponse {
-    MostReportedGames: ReportedGameEntity[];
-    URL: string;
-}
-export {};
+interface ReportedGameEntity {
+    GameID: string;
+    GameTitle: string;
+    GameIcon: string;
+    Console: string;
+    OpenTickets: string;
+}
+export interface MostTicketedGamesResponse {
+    MostReportedGames: ReportedGameEntity[];
+    URL: string;
+}
+export {};

package/dist/ticket/models/most-ticketed-games.model.d.ts

@@ -1,11 +1,11 @@
-export interface ReportedGameEntity {
-    gameId: number;
-    gameTitle: string;
-    gameIcon: string;
-    console: string;
-    openTickets: number;
-}
-export interface MostTicketedGames {
-    mostReportedGames: ReportedGameEntity[];
-    url: string;
-}
+export interface ReportedGameEntity {
+    gameId: number;
+    gameTitle: string;
+    gameIcon: string;
+    console: string;
+    openTickets: number;
+}
+export interface MostTicketedGames {
+    mostReportedGames: ReportedGameEntity[];
+    url: string;
+}

package/dist/ticket/models/recent-tickets-response.model.d.ts

@@ -1,6 +1,6 @@
-import type { ResponseTicketEntity } from "./response-ticket-entity.model";
-export interface RecentTicketsResponse {
-    RecentTickets: ResponseTicketEntity[];
-    OpenTickets: number;
-    URL: string;
-}
+import type { ResponseTicketEntity } from "./response-ticket-entity.model";
+export interface RecentTicketsResponse {
+    RecentTickets: ResponseTicketEntity[];
+    OpenTickets: number;
+    URL: string;
+}

package/dist/ticket/models/recent-tickets.model.d.ts

@@ -1,6 +1,6 @@
-import type { TicketEntity } from "./ticket-entity.model";
-export interface RecentTickets {
-    recentTickets: TicketEntity[];
-    openTickets: number;
-    url: string;
-}
+import type { TicketEntity } from "./ticket-entity.model";
+export interface RecentTickets {
+    recentTickets: TicketEntity[];
+    openTickets: number;
+    url: string;
+}

package/dist/ticket/models/response-ticket-entity.model.d.ts

@@ -1,24 +1,24 @@
-export interface ResponseTicketEntity {
-    ID: string;
-    AchievementID: string;
-    AchievementTitle: string;
-    AchievementDesc: string;
-    Points: string;
-    BadgeName: string;
-    AchievementAuthor: string;
-    GameID: string;
-    ConsoleName: string;
-    GameTitle: string;
-    GameIcon: string;
-    ReportedAt: string;
-    ReportType: string;
-    ReportState: string;
-    Hardcore: "0" | "1" | null;
-    ReportNotes: string;
-    ReportedBy: string;
-    ResolvedAt: string | null;
-    ResolvedBy: string | null;
-    ReportStateDescription: string;
-    ReportTypeDescription: string;
-    URL?: string;
-}
+export interface ResponseTicketEntity {
+    ID: string;
+    AchievementID: string;
+    AchievementTitle: string;
+    AchievementDesc: string;
+    Points: string;
+    BadgeName: string;
+    AchievementAuthor: string;
+    GameID: string;
+    ConsoleName: string;
+    GameTitle: string;
+    GameIcon: string;
+    ReportedAt: string;
+    ReportType: string;
+    ReportState: string;
+    Hardcore: "0" | "1" | null;
+    ReportNotes: string;
+    ReportedBy: string;
+    ResolvedAt: string | null;
+    ResolvedBy: string | null;
+    ReportStateDescription: string;
+    ReportTypeDescription: string;
+    URL?: string;
+}

package/dist/ticket/models/ticket-entity.model.d.ts

@@ -1,24 +1,24 @@
-export interface TicketEntity {
-    id: number;
-    achievementId: number;
-    achievementTitle: string;
-    achievementDesc: string;
-    points: number;
-    badgeName: string;
-    achievementAuthor: string;
-    gameId: number;
-    consoleName: string;
-    gameTitle: string;
-    gameIcon: string;
-    reportedAt: string;
-    reportType: number;
-    reportState: number;
-    hardcore: boolean | null;
-    reportNotes: string;
-    reportedBy: string;
-    resolvedAt: string | null;
-    resolvedBy: string | null;
-    reportStateDescription: string;
-    reportTypeDescription: string;
-    url: string;
-}
+export interface TicketEntity {
+    id: number;
+    achievementId: number;
+    achievementTitle: string;
+    achievementDesc: string;
+    points: number;
+    badgeName: string;
+    achievementAuthor: string;
+    gameId: number;
+    consoleName: string;
+    gameTitle: string;
+    gameIcon: string;
+    reportedAt: string;
+    reportType: number;
+    reportState: number;
+    hardcore: boolean | null;
+    reportNotes: string;
+    reportedBy: string;
+    resolvedAt: string | null;
+    resolvedBy: string | null;
+    reportStateDescription: string;
+    reportTypeDescription: string;
+    url: string;
+}

package/dist/ticket/models/tickets-by-user-response.model.d.ts

@@ -1,8 +1,8 @@
-export interface TicketsByUserResponse {
-    User: string;
-    Open: number;
-    Closed: number;
-    Resolved: number;
-    Total: number;
-    URL: string;
-}
+export interface TicketsByUserResponse {
+    User: string;
+    Open: number;
+    Closed: number;
+    Resolved: number;
+    Total: number;
+    URL: string;
+}

package/dist/ticket/models/user-ticket-stats.model.d.ts

@@ -1,8 +1,8 @@
-export interface UserTicketStats {
-    user: string;
-    open: number;
-    closed: number;
-    resolved: number;
-    total: number;
-    url: string;
-}
+export interface UserTicketStats {
+    user: string;
+    open: number;
+    closed: number;
+    resolved: number;
+    total: number;
+    url: string;
+}