@easecation/ecapi-sdk 0.1.0 → 0.1.2

package/README.md

@@ -38,6 +38,19 @@ client.setAppSessionToken(process.env.EC_APP_SESSION_TOKEN!);
 - 支持 per-request 覆盖鉴权：`options.auth`
 - 非 2xx 响应抛出 `ECAPIError`（包含 `status`、`payload`、`url`）
 
+## 参数传递（必填/可选）
+
+- 所有查询参数统一通过对象传入：`client.player.getWallet({ ecid: "..." })`
+- `QueryParams` 已补齐服务端常用 query key 自动提示
+- 每个 API 的必填/可选参数请查看：`API_REFERENCE.md`
+- 该参考文档由后端 OpenAPI 自动生成，和服务端校验保持一致
+
+## IDE 强类型提示
+
+- 包内提供方法级类型增强文件 `method-signatures.d.ts`
+- 调用每个 API 时，IDE 会提示该方法对应的 `Query` / `Body` 类型
+- 必填字段会在 TypeScript 类型检查中直接报错，减少运行时试错
+
 ## API 覆盖
 
 > 下列为 SDK 已封装的主要接口，未覆盖部分可通过 `client.request(...)` 直接调用。
@@ -110,3 +123,13 @@ client.setAppSessionToken(process.env.EC_APP_SESSION_TOKEN!);
 - `client.monitor.spamDetector.*` → `/monitor/spam-detector/*`
 - `client.system.getHealth()` → `/health`
 
+## 完整 API 参考
+
+- `API_REFERENCE.md`
+
+更新命令（在 `easecation-api` 根目录执行）：
+
+```bash
+python3 sdk/generate_sdk_api_reference.py
+```
+

package/dist/apis.d.ts

@@ -1,6 +1,10 @@
 import { ECAPIHttpClient } from "./http";
 import { QueryParams, RequestOptions } from "./types";
 type NonBodyOptions = Omit<RequestOptions, "query" | "body">;
+/**
+ * Shared low-level HTTP wrappers used by all API groups.
+ * These helpers keep auth/header/retry behavior consistent across modules.
+ */
 declare class BaseApi {
     protected readonly http: ECAPIHttpClient;
     constructor(http: ECAPIHttpClient);
@@ -11,46 +15,22 @@ declare class BaseApi {
     protected delete<T = unknown>(path: string, query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<T>;
 }
 export declare class UserApi extends BaseApi {
-    getMe(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    loginByPassword(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    loginByOauth2(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    refreshToken(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    getOpenId(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    listAll(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    updatePermissions(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    getById(id: string, query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class PlayerScoreApi extends BaseApi {
-    getScore(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getStages(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getTop(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    deleteTop(query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
-    getConfig(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getLeaderboard(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class PlayerTasksApi extends BaseApi {
-    list(ecid: string, query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    create(ecid: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     update(ecid: string, taskId: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     deleteOne(ecid: string, taskId: string, query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
 }
 export declare class PlayerMerchandiseApi extends BaseApi {
-    list(ecid: string, query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    create(ecid: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     update(ecid: string, idItem: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     deleteOne(ecid: string, idItem: string, query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
 }
 export declare class PlayerYearSummaryApi extends BaseApi {
-    getBasicInfo(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getLoginStats(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getGameStats(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getRankData(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getCurrencyData(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getSocialData(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class PlayerVoteApi extends BaseApi {
-    processRewards(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
+/** Player-related endpoints and nested modules. */
 export declare class PlayerApi extends BaseApi {
     readonly score: PlayerScoreApi;
     readonly tasks: PlayerTasksApi;
@@ -58,156 +38,51 @@ export declare class PlayerApi extends BaseApi {
     readonly yearSummary: PlayerYearSummaryApi;
     readonly vote: PlayerVoteApi;
     constructor(http: ECAPIHttpClient);
-    getInfo(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    searchEcid(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getUserData(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    queryNetease(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    setRankLevel(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    clearRespackCache(query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
-    getWallet(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    listGamingTags(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    operateGamingTag(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    getLastPlayed(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getStageRecord(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getHeadicon(query?: QueryParams, options?: Omit<RequestOptions, "query" | "responseType">): Promise<ArrayBuffer>;
-    getSkin(query?: QueryParams, options?: Omit<RequestOptions, "query" | "responseType">): Promise<ArrayBuffer>;
-    batchNeteaseNicknames(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    getBinding(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    resetBinding(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    updateBinding(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    updateUserData(nick: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    updatePassword(ecid: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    getPasswordHash(ecid: string, query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class AdminApi extends BaseApi {
-    sendMail(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    prismDeviceBan(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    getPrismDeviceBanLog(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    upsertOverwatchCase(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    getOverwatchCase(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getOperationLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getOperationStatistics(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class PunishApi extends BaseApi {
-    hack(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    ban(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    unban(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    mute(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    unmute(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    warn(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    kick(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    clearDegree(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    overwatch(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
 }
 export declare class BanApi extends BaseApi {
-    ban(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    clearDegree(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    parkourPunish(query?: QueryParams, payload?: Record<string, unknown>, options?: Omit<RequestOptions, "query" | "body">): Promise<unknown>;
 }
 export declare class PermissionApi extends BaseApi {
-    getPermission(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    upsert(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    deleteOne(query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
 }
 export declare class LogApi extends BaseApi {
-    getAction(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getChat(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getAuth(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getTeaming(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getLatestTeaming(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getCommand(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getMail(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class OrderApi extends BaseApi {
-    getDeliver(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getExchangeLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getDownloadCount(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    createDownloadTask(query?: QueryParams, payload?: Record<string, unknown>, options?: Omit<RequestOptions, "query" | "body">): Promise<unknown>;
-    getDownloadStatus(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    listDownloadTasks(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class StageLogApi extends BaseApi {
-    list(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    query(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class StageApi extends BaseApi {
     readonly logs: StageLogApi;
     constructor(http: ECAPIHttpClient);
-    getTypes(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    create(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    getInfo(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getDbId(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class ItemApi extends BaseApi {
-    getCommodity(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class CountApi extends BaseApi {
-    getHistory(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getLatest(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getTypes(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class ServersApi extends BaseApi {
-    list(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getStatistics(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getMainstackEvent(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class LobbyApi extends BaseApi {
-    list(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class CfgLangApi extends BaseApi {
-    list(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    compare(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    deploy(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    create(query: QueryParams | undefined, payload: Record<string, unknown>, options?: Omit<RequestOptions, "query" | "body">): Promise<unknown>;
-    update(query: QueryParams | undefined, payload: Record<string, unknown>, options?: Omit<RequestOptions, "query" | "body">): Promise<unknown>;
-    deleteOne(query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
 }
 export declare class GlobalKVApi extends BaseApi {
-    list(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getOne(key: string, query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    create(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    update(key: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    deleteOne(key: string, query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
-    deleteBatch(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
 }
 export declare class BroadcastApi extends BaseApi {
-    list(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    compare(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    deploy(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    getOne(msg: string, query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    create(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    update(msg: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    deleteOne(msg: string, payload?: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
 }
 export declare class EaseChatApi extends BaseApi {
-    sendHlaba(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    listSubscriptions(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    createSubscription(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    deleteSubscription(query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
 }
 export declare class AuditApi extends BaseApi {
-    getAuthLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getPlayerLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getPunishmentLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getPermissionLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getAdminLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getConfigLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class SpamDetectorApi extends BaseApi {
-    getStatus(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    control(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
-    getStats(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class MonitorApi extends BaseApi {
     readonly spamDetector: SpamDetectorApi;
     constructor(http: ECAPIHttpClient);
 }
 export declare class PullConfigApi extends BaseApi {
-    pull(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class SystemApi extends BaseApi {
-    getRoot(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
-    getHealth(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export {};

package/dist/apis.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SystemApi = exports.PullConfigApi = exports.MonitorApi = exports.SpamDetectorApi = exports.AuditApi = exports.EaseChatApi = exports.BroadcastApi = exports.GlobalKVApi = exports.CfgLangApi = exports.LobbyApi = exports.ServersApi = exports.CountApi = exports.ItemApi = exports.StageApi = exports.StageLogApi = exports.OrderApi = exports.LogApi = exports.PermissionApi = exports.BanApi = exports.PunishApi = exports.AdminApi = exports.PlayerApi = exports.PlayerVoteApi = exports.PlayerYearSummaryApi = exports.PlayerMerchandiseApi = exports.PlayerTasksApi = exports.PlayerScoreApi = exports.UserApi = void 0;
+/**
+ * Shared low-level HTTP wrappers used by all API groups.
+ * These helpers keep auth/header/retry behavior consistent across modules.
+ */
 class BaseApi {
     constructor(http) {
         this.http = http;
@@ -22,6 +26,10 @@ class BaseApi {
     }
 }
 class UserApi extends BaseApi {
+    /**
+     * Get current user profile.
+     * Note: backend expects Authorization token for this endpoint in some deployments.
+     */
     getMe(query, options) {
         return this.get("/user/me", query, options);
     }
@@ -34,27 +42,42 @@ class UserApi extends BaseApi {
     refreshToken(payload, options) {
         return this.post("/user/refresh", payload, options);
     }
+    /**
+     * Get current user's OpenID.
+     * May return 404 if OpenID context is unavailable for current auth mode.
+     */
     getOpenId(query, options) {
         return this.get("/user/openid", query, options);
     }
+    /** List all registered users (admin-scoped endpoint). */
     listAll(query, options) {
         return this.get("/user/all", query, options);
     }
     updatePermissions(payload, options) {
         return this.put("/user/permissions", payload, options);
     }
+    /** Query user detail by user id. */
     getById(id, query, options) {
         return this.get(`/user/${encodeURIComponent(id)}`, query, options);
     }
 }
 exports.UserApi = UserApi;
 class PlayerScoreApi extends BaseApi {
+    /**
+     * Get player score summary.
+     * Common required query: `nick`, `game`.
+     */
     getScore(query, options) {
         return super.get("/player/score", query, options);
     }
+    /** Get player score stages. Common required query: `nick`. */
     getStages(query, options) {
         return super.get("/player/score/stages", query, options);
     }
+    /**
+     * Get top ranking records.
+     * Common required query: `game`, `score_type`, `deadline_type`, `limit`, `is_ascending`.
+     */
     getTop(query, options) {
         return super.get("/player/score/top", query, options);
     }
@@ -70,6 +93,10 @@ class PlayerScoreApi extends BaseApi {
 }
 exports.PlayerScoreApi = PlayerScoreApi;
 class PlayerTasksApi extends BaseApi {
+    /**
+     * List tasks for one player.
+     * Common required query: `current`, `pageSize`.
+     */
     list(ecid, query, options) {
         return this.get(`/player/${encodeURIComponent(ecid)}/tasks`, query, options);
     }
@@ -85,6 +112,10 @@ class PlayerTasksApi extends BaseApi {
 }
 exports.PlayerTasksApi = PlayerTasksApi;
 class PlayerMerchandiseApi extends BaseApi {
+    /**
+     * List merchandise items for one player.
+     * Common required query: `current`, `pageSize`.
+     */
     list(ecid, query, options) {
         return this.get(`/player/${encodeURIComponent(ecid)}/merchandise`, query, options);
     }
@@ -100,6 +131,7 @@ class PlayerMerchandiseApi extends BaseApi {
 }
 exports.PlayerMerchandiseApi = PlayerMerchandiseApi;
 class PlayerYearSummaryApi extends BaseApi {
+    /** Get year summary basic info. Common required query: `ecid` (optional `year`). */
     getBasicInfo(query, options) {
         return this.get("/player/year-summary/basic-info", query, options);
     }
@@ -121,11 +153,13 @@ class PlayerYearSummaryApi extends BaseApi {
 }
 exports.PlayerYearSummaryApi = PlayerYearSummaryApi;
 class PlayerVoteApi extends BaseApi {
+    /** Process vote rewards. Common required query: `players` (semicolon-separated). */
     processRewards(query, options) {
         return this.get("/player/vote", query, options);
     }
 }
 exports.PlayerVoteApi = PlayerVoteApi;
+/** Player-related endpoints and nested modules. */
 class PlayerApi extends BaseApi {
     constructor(http) {
         super(http);
@@ -135,15 +169,19 @@ class PlayerApi extends BaseApi {
         this.yearSummary = new PlayerYearSummaryApi(http);
         this.vote = new PlayerVoteApi(http);
     }
+    /** Get online/runtime player info. Common required query: `name`. */
     getInfo(query, options) {
         return this.get("/player/info", query, options);
     }
+    /** Search ECID by nickname/ecid keyword. Common required query: `name`. */
     searchEcid(query, options) {
         return this.get("/player/searchecid", query, options);
     }
+    /** Get player profile data. Common required query: `ecid`. */
     getUserData(query, options) {
         return this.get("/player/userdata", query, options);
     }
+    /** Query NetEase player data. Common required query: `name`. */
     queryNetease(query, options) {
         return this.get("/player/querynetease", query, options);
     }
@@ -153,6 +191,7 @@ class PlayerApi extends BaseApi {
     clearRespackCache(query, options) {
         return this.delete("/player/respack/cache", query, options);
     }
+    /** Get wallet info. Common required query: `ecid`. */
     getWallet(query, options) {
         return this.get("/player/wallet", query, options);
     }
@@ -162,12 +201,15 @@ class PlayerApi extends BaseApi {
     operateGamingTag(payload, options) {
         return this.post("/player/gaming-tag", payload, options);
     }
+    /** Get recent play history. Common required query: `ecid`. */
     getLastPlayed(query, options) {
         return this.get("/player/last-played", query, options);
     }
+    /** Get stage records. Common required query: `ecid`, `start`, `end`. */
     getStageRecord(query, options) {
         return this.get("/player/stage/record", query, options);
     }
+    /** Get player head icon as binary image data. Common required query: `ecid`. */
     getHeadicon(query, options) {
         return this.http.request("GET", "/player/headicon", {
             ...options,
@@ -175,6 +217,7 @@ class PlayerApi extends BaseApi {
             responseType: "arrayBuffer",
         });
     }
+    /** Get player skin as binary image data. Common required query: `ecid`. */
     getSkin(query, options) {
         return this.http.request("GET", "/player/skin", {
             ...options,
@@ -185,6 +228,7 @@ class PlayerApi extends BaseApi {
     batchNeteaseNicknames(payload, options) {
         return this.post("/player/neteasenicknames", payload, options);
     }
+    /** Get player binding info. Common required query: `ecid`. */
     getBinding(query, options) {
         return this.get("/player/binding", query, options);
     }
@@ -200,6 +244,7 @@ class PlayerApi extends BaseApi {
     updatePassword(ecid, payload, options) {
         return this.post(`/player/password/${encodeURIComponent(ecid)}`, payload, options);
     }
+    /** Get password hash by ecid. */
     getPasswordHash(ecid, query, options) {
         return this.get(`/player/password/${encodeURIComponent(ecid)}`, query, options);
     }
@@ -218,12 +263,15 @@ class AdminApi extends BaseApi {
     upsertOverwatchCase(payload, options) {
         return this.post("/admin/overwatch", payload, options);
     }
+    /** Query overwatch case. Common required query: `record_id`. */
     getOverwatchCase(query, options) {
         return this.get("/admin/overwatch", query, options);
     }
+    /** Query admin operation logs. Common required query: `start`/`end` or `target_nick`. */
     getOperationLogs(query, options) {
         return this.get("/admin/operation", query, options);
     }
+    /** Query admin operation statistics. Common required query: `start`, `end`. */
     getOperationStatistics(query, options) {
         return this.get("/admin/operation/statistic", query, options);
     }
@@ -276,6 +324,7 @@ class BanApi extends BaseApi {
 }
 exports.BanApi = BanApi;
 class PermissionApi extends BaseApi {
+    /** Get player permission. Common required query: `ecid`. */
     getPermission(query, options) {
         return super.get("/permission", query, options);
     }
@@ -288,6 +337,7 @@ class PermissionApi extends BaseApi {
 }
 exports.PermissionApi = PermissionApi;
 class LogApi extends BaseApi {
+    /** Query action log. Common required query: `start`, `end`, `ecid`. */
     getAction(query, options) {
         return this.get("/log/action", query, options);
     }
@@ -297,12 +347,14 @@ class LogApi extends BaseApi {
     getAuth(query, options) {
         return this.get("/log/auth", query, options);
     }
+    /** Query teaming log. Common required query: `start`, `end`, `current`, `ecid`. */
     getTeaming(query, options) {
         return this.get("/log/teaming", query, options);
     }
     getLatestTeaming(query, options) {
         return this.get("/log/latestTeaming", query, options);
     }
+    /** Query command log. Common required query: `start`, `end`, `current`, `ecid`. */
     getCommand(query, options) {
         return this.get("/log/command", query, options);
     }
@@ -312,15 +364,19 @@ class LogApi extends BaseApi {
 }
 exports.LogApi = LogApi;
 class OrderApi extends BaseApi {
+    /** Query delivery status. Common required query: `key`, `ecid`. */
     getDeliver(query, options) {
         return this.get("/order/deliver", query, options);
     }
+    /** Query order logs. Common required query: `ecid`. */
     getLogs(query, options) {
         return this.get("/order/logs", query, options);
     }
+    /** Query exchange logs. Common required query: `ecid`, `from`, `to`. */
     getExchangeLogs(query, options) {
         return this.get("/order/exchange-logs", query, options);
     }
+    /** Get download task count. Common required query: `from`, `to`. */
     getDownloadCount(query, options) {
         return this.get("/order/download/count", query, options);
     }
@@ -331,6 +387,7 @@ class OrderApi extends BaseApi {
             body: payload,
         });
     }
+    /** Get one download task status. Common required query: `downloadId`. */
     getDownloadStatus(query, options) {
         return this.get("/order/download/status", query, options);
     }
@@ -359,9 +416,11 @@ class StageApi extends BaseApi {
     create(payload, options) {
         return this.post("/stage/create", payload, options);
     }
+    /** Query stage info by filters such as game/state/runtimeid/requestid. */
     getInfo(query, options) {
         return this.get("/stage/info", query, options);
     }
+    /** Query stage DB id. Common required query: `runtime-id`. */
     getDbId(query, options) {
         return this.get("/stage/db-id", query, options);
     }
@@ -528,15 +587,18 @@ class MonitorApi extends BaseApi {
 }
 exports.MonitorApi = MonitorApi;
 class PullConfigApi extends BaseApi {
+    /** Pull current config snapshot. */
     pull(query, options) {
         return this.get("/pull-config", query, options);
     }
 }
 exports.PullConfigApi = PullConfigApi;
 class SystemApi extends BaseApi {
+    /** Get API root text payload. */
     getRoot(query, options) {
         return this.get("/", query, { ...options, responseType: "text" });
     }
+    /** Health check endpoint. */
     getHealth(query, options) {
         return this.get("/health", query, options);
     }

package/dist/index.d.ts

@@ -1,7 +1,16 @@
+/// <reference path="../src/method-signatures.d.ts" />
 import { ECAPIError } from "./http";
 import { AdminApi, AuditApi, BanApi, BroadcastApi, CfgLangApi, CountApi, EaseChatApi, GlobalKVApi, ItemApi, LobbyApi, LogApi, MonitorApi, OrderApi, PermissionApi, PlayerApi, PullConfigApi, PunishApi, ServersApi, StageApi, SystemApi, UserApi } from "./apis";
 import { AuthCredentials, ClientOptions, RequestOptions } from "./types";
 type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+/**
+ * ECAPI main client.
+ *
+ * Usage:
+ * 1) Create a client with `baseUrl` and one auth method.
+ * 2) Call grouped APIs via `client.user`, `client.player`, etc.
+ * 3) Use `request()` for endpoints not wrapped by typed helpers.
+ */
 export declare class ECAPIClient {
     private readonly http;
     readonly user: UserApi;
@@ -25,11 +34,31 @@ export declare class ECAPIClient {
     readonly monitor: MonitorApi;
     readonly pullConfig: PullConfigApi;
     readonly system: SystemApi;
+    /**
+     * Initialize a new ECAPI client.
+     */
     constructor(options: ClientOptions);
+    /**
+     * Replace current auth config for subsequent requests.
+     */
     setAuth(auth?: AuthCredentials): void;
+    /**
+     * Use IAM API Key auth for subsequent requests.
+     */
     setApiKey(apiKey: string): void;
+    /**
+     * Use app session token auth for subsequent requests.
+     */
     setAppSessionToken(appSessionToken: string): void;
+    /**
+     * Clear auth headers from subsequent requests.
+     */
     clearAuth(): void;
+    /**
+     * Low-level request helper.
+     *
+     * Use this when an endpoint is not yet wrapped by a high-level API method.
+     */
     request<T = unknown>(method: HttpMethod, path: string, options?: RequestOptions): Promise<T>;
 }
 export * from "./types";

package/dist/index.js

@@ -15,10 +15,22 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ECAPIError = exports.ECAPIClient = void 0;
+/// <reference path="./method-signatures.d.ts" />
 const http_1 = require("./http");
 Object.defineProperty(exports, "ECAPIError", { enumerable: true, get: function () { return http_1.ECAPIError; } });
 const apis_1 = require("./apis");
+/**
+ * ECAPI main client.
+ *
+ * Usage:
+ * 1) Create a client with `baseUrl` and one auth method.
+ * 2) Call grouped APIs via `client.user`, `client.player`, etc.
+ * 3) Use `request()` for endpoints not wrapped by typed helpers.
+ */
 class ECAPIClient {
+    /**
+     * Initialize a new ECAPI client.
+     */
     constructor(options) {
         this.http = new http_1.ECAPIHttpClient(options);
         this.user = new apis_1.UserApi(this.http);
@@ -43,18 +55,35 @@ class ECAPIClient {
         this.pullConfig = new apis_1.PullConfigApi(this.http);
         this.system = new apis_1.SystemApi(this.http);
     }
+    /**
+     * Replace current auth config for subsequent requests.
+     */
     setAuth(auth) {
         this.http.setAuth(auth);
     }
+    /**
+     * Use IAM API Key auth for subsequent requests.
+     */
     setApiKey(apiKey) {
         this.http.setApiKey(apiKey);
     }
+    /**
+     * Use app session token auth for subsequent requests.
+     */
     setAppSessionToken(appSessionToken) {
         this.http.setAppSessionToken(appSessionToken);
     }
+    /**
+     * Clear auth headers from subsequent requests.
+     */
     clearAuth() {
         this.http.clearAuth();
     }
+    /**
+     * Low-level request helper.
+     *
+     * Use this when an endpoint is not yet wrapped by a high-level API method.
+     */
     request(method, path, options) {
         return this.http.request(method, path, options);
     }