@pinta365/blizzard_api 0.4.0 → 0.5.0

package/script/src/generated/sc2_api.d.ts

@@ -0,0 +1,139 @@
+import type { League } from "../starcraft2/game_data/league.js";
+import type { Sc2GrandmasterLeaderboard, Sc2Season } from "../starcraft2/community/ladder.js";
+import type { Sc2Ladder, Sc2LadderSummary, Sc2PlayerProfile, Sc2ProfileMetadata, Sc2StaticProfile } from "../starcraft2/community/profile.js";
+import type { Sc2LegacyAchievements, Sc2LegacyLadder, Sc2LegacyLadders, Sc2LegacyMatches, Sc2LegacyProfile, Sc2LegacyRewards } from "../starcraft2/community/legacy.js";
+import type { Sc2Player } from "../starcraft2/community/account.js";
+/**
+ * StarCraft II endpoints.
+ */
+export interface Sc2Api {
+    /**
+     * Returns the grandmaster leaderboard for a region.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @returns A promise that resolves to an object representing the grandmaster leaderboard.
+     */
+    grandmasterLeaderboard(regionId: number): Promise<Sc2GrandmasterLeaderboard>;
+    /**
+     * Returns a StarCraft II ladder.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @param realmId - The realm: 1 or 2.
+     * @param profileId - The unique identifier for the profile.
+     * @param ladderId - The unique identifier for the ladder.
+     * @returns A promise that resolves to an object representing the ladder.
+     */
+    ladder(regionId: number, realmId: number, profileId: number, ladderId: string): Promise<Sc2Ladder>;
+    /**
+     * Returns the ladder summary of a StarCraft II profile.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @param realmId - The realm: 1 or 2.
+     * @param profileId - The unique identifier for the profile.
+     * @returns A promise that resolves to an object representing the ladder summary.
+     */
+    ladderSummary(regionId: number, realmId: number, profileId: number): Promise<Sc2LadderSummary>;
+    /**
+     * Returns data for the specified season, queue, team, and league.
+     *
+     * Notes from the battle.net docs:
+     * queueId: the standard available queueIds are: 1=WoL 1v1, 2=WoL 2v2, 3=WoL 3v3, 4=WoL 4v4, 101=HotS 1v1, 102=HotS 2v2, 103=HotS 3v3, 104=HotS 4v4, 201=LotV 1v1, 202=LotV 2v2, 203=LotV 3v3, 204=LotV 4v4, 206=LotV Archon. Note that other available queues may not be listed here.
+     * teamType: there are two available teamTypes: 0=arranged, 1=random.
+     * leagueId: available leagueIds are: 0=Bronze, 1=Silver, 2=Gold, 3=Platinum, 4=Diamond, 5=Master, 6=Grandmaster.
+     *
+     * @param seasonId - The season ID of the data to retrieve.
+     * @param queueId - The queue ID of the data to retrieve.
+     * @param teamType - The team type of the data to retrieve.
+     * @param leagueId - The league ID of the data to retrieve.
+     * @returns A promise that resolves to an object representing the data for a league.
+     */
+    leagueData(seasonId: number, queueId: number, teamType: number, leagueId: number): Promise<League>;
+    /**
+     * Returns the legacy StarCraft II achievements for a region.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @returns A promise that resolves to an object representing the legacy achievements.
+     */
+    legacyAchievements(regionId: number): Promise<Sc2LegacyAchievements>;
+    /**
+     * Returns a legacy StarCraft II ladder.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @param ladderId - The unique identifier for the ladder.
+     * @returns A promise that resolves to an object representing the legacy ladder.
+     */
+    legacyLadder(regionId: number, ladderId: string): Promise<Sc2LegacyLadder>;
+    /**
+     * Returns the legacy StarCraft II ladders of a player.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @param realmId - The realm: 1 or 2.
+     * @param profileId - The unique identifier for the profile.
+     * @returns A promise that resolves to an object representing the legacy ladders.
+     */
+    legacyLadders(regionId: number, realmId: number, profileId: number): Promise<Sc2LegacyLadders>;
+    /**
+     * Returns the legacy StarCraft II matches of a player.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @param realmId - The realm: 1 or 2.
+     * @param profileId - The unique identifier for the profile.
+     * @returns A promise that resolves to an object representing the legacy matches.
+     */
+    legacyMatches(regionId: number, realmId: number, profileId: number): Promise<Sc2LegacyMatches>;
+    /**
+     * Returns the legacy StarCraft II profile of a player.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @param realmId - The realm: 1 or 2.
+     * @param profileId - The unique identifier for the profile.
+     * @returns A promise that resolves to an object representing the legacy profile.
+     */
+    legacyProfile(regionId: number, realmId: number, profileId: number): Promise<Sc2LegacyProfile>;
+    /**
+     * Returns the legacy StarCraft II rewards for a region.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @returns A promise that resolves to an object representing the legacy rewards.
+     */
+    legacyRewards(regionId: number): Promise<Sc2LegacyRewards>;
+    /**
+     * Returns the metadata of a StarCraft II profile.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @param realmId - The realm: 1 or 2.
+     * @param profileId - The unique identifier for the profile.
+     * @returns A promise that resolves to an object representing the profile metadata.
+     */
+    metadataProfile(regionId: number, realmId: number, profileId: number): Promise<Sc2ProfileMetadata>;
+    /**
+     * Returns the StarCraft II players linked to an account.
+     *
+     * @param accountId - The unique identifier for the account.
+     * @returns A promise that resolves to an array of players linked to the account.
+     */
+    player(accountId: number): Promise<Sc2Player[]>;
+    /**
+     * Returns a StarCraft II profile.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @param realmId - The realm: 1 or 2.
+     * @param profileId - The unique identifier for the profile.
+     * @returns A promise that resolves to an object representing the profile.
+     */
+    profile(regionId: number, realmId: number, profileId: number): Promise<Sc2PlayerProfile>;
+    /**
+     * Returns the current season for a region.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @returns A promise that resolves to an object representing the season.
+     */
+    season(regionId: number): Promise<Sc2Season>;
+    /**
+     * Returns the static StarCraft II profile data (achievements, criteria, categories and rewards) for a region.
+     *
+     * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+     * @returns A promise that resolves to an object representing the static profile data.
+     */
+    staticProfile(regionId: number): Promise<Sc2StaticProfile>;
+}

package/script/src/generated/sc2_api.js

@@ -0,0 +1,3 @@
+"use strict";
+// Generated by scripts/gen_api.ts from src/starcraft2/index.ts. Do not edit; run `deno task gen:api`.
+Object.defineProperty(exports, "__esModule", { value: true });