maplestory-openapi 3.3.0 → 3.4.1

package/types/maplestory/api/tms/mapleStoryApi.d.ts

@@ -0,0 +1,364 @@
+import { CharacterDto } from './dto/character/character';
+import { CharacterAbilityDto } from './dto/character/characterAbility';
+import { CharacterAndroidEquipmentDto } from './dto/character/characterAndroidEquipment';
+import { CharacterBasicDto } from './dto/character/characterBasic';
+import { CharacterBeautyEquipmentDto } from './dto/character/characterBeautyEquipment';
+import { CharacterCashItemEquipmentDto } from './dto/character/characterCashItemEquipment';
+import { CharacterDojangDto } from './dto/character/characterDojang';
+import { CharacterHexaMatrixDto } from './dto/character/characterHexaMatrix';
+import { CharacterHexaMatrixStatDto } from './dto/character/characterHexaMatrixStat';
+import { CharacterHyperStatDto } from './dto/character/characterHyperStat';
+import { CharacterImageDto } from './dto/character/characterImage';
+import { CharacterItemEquipmentDto } from './dto/character/characterItemEquipment';
+import { CharacterLinkSkillDto } from './dto/character/characterLinkSkill';
+import { CharacterPetEquipmentDto } from './dto/character/characterPetEquipment';
+import { CharacterPopularityDto } from './dto/character/characterPopularity';
+import { CharacterPropensityDto } from './dto/character/characterPropensity';
+import { CharacterSetEffectDto } from './dto/character/characterSetEffect';
+import { CharacterSkillDto } from './dto/character/characterSkill';
+import { CharacterStatDto } from './dto/character/characterStat';
+import { CharacterSymbolEquipmentDto } from './dto/character/characterSymbolEquipment';
+import { CharacterVMatrixDto } from './dto/character/characterVMatrix';
+import { GuildDto } from './dto/guild/guild';
+import { GuildBasicDto } from './dto/guild/guildBasic';
+import { UnionDto } from './dto/union/union';
+import { UnionArtifactDto } from './dto/union/unionArtifact';
+import { UnionRaiderDto } from './dto/union/unionRaider';
+import { CharacterImageAction, CharacterImageEmotion, CharacterImageWeaponMotion } from '../common/enum/characterImage';
+import { DateOptions } from '../common/mapleStoryApi';
+import * as base from '../common/mapleStoryApi';
+/**
+ * MapleStory OpenAPI client for TMS.<br>
+ * This is an implementation of <a href="https://openapi.nexon.com/game/maplestorytw">MapleStory API</a>
+ */
+export declare class MapleStoryApi extends base.MapleStoryApi {
+    protected subUrl: string;
+    protected timezoneOffset: number;
+    constructor(apiKey: string);
+    /**
+     * 檢視角色辨識器 (OCID)。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param characterName 角色名稱
+     */
+    getCharacter(characterName: string): Promise<CharacterDto>;
+    /**
+     * 檢視基本資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterBasic(ocid: string, dateOptions?: DateOptions): Promise<CharacterBasicDto>;
+    /**
+     * 檢視角色外型圖片資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param imageOptions 圖像選項
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterImage(ocid: string, imageOptions?: CharacterImageOptions, dateOptions?: DateOptions): Promise<CharacterImageDto>;
+    /**
+     * 檢視名聲資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterPopularity(ocid: string, dateOptions?: DateOptions): Promise<CharacterPopularityDto>;
+    /**
+     * 檢視綜合能力值資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterStat(ocid: string, dateOptions?: DateOptions): Promise<CharacterStatDto>;
+    /**
+     * 檢視極限屬性資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterHyperStat(ocid: string, dateOptions?: DateOptions): Promise<CharacterHyperStatDto>;
+    /**
+     * 檢視性向資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterPropensity(ocid: string, dateOptions?: DateOptions): Promise<CharacterPropensityDto>;
+    /**
+     * 檢視能力資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterAbility(ocid: string, dateOptions?: DateOptions): Promise<CharacterAbilityDto>;
+    /**
+     * 檢視已裝備道具資訊 (不含現金道具)。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterItemEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterItemEquipmentDto>;
+    /**
+     * 檢視已裝備現金道具資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterCashItemEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterCashItemEquipmentDto>;
+    /**
+     * 檢視已裝備符文資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterSymbolEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterSymbolEquipmentDto>;
+    /**
+     * 檢視目前套用的套裝效果資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterSetEffect(ocid: string, dateOptions?: DateOptions): Promise<CharacterSetEffectDto>;
+    /**
+     * 檢視目前已裝備的髮型、臉型與膚色資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterBeautyEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterBeautyEquipmentDto>;
+    /**
+     * 檢視已裝備機器人資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterAndroidEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterAndroidEquipmentDto>;
+    /**
+     * 檢視已裝備寵物、寵物技能與寵物道具資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterPetEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterPetEquipmentDto>;
+    /**
+     * 檢視角色技能與超技能資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param characterSkillGrade 您要檢視的轉職階段 <a href="https://openapi.nexon.com/game/maplestorytw/?id=49">Available values</a>
+     *  @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterSkill(ocid: string, characterSkillGrade: string, dateOptions?: DateOptions): Promise<CharacterSkillDto>;
+    /**
+     * 檢視已裝備連結技能資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterLinkSkill(ocid: string, dateOptions?: DateOptions): Promise<CharacterLinkSkillDto>;
+    /**
+     * 檢視 V 矩陣欄位資訊與已裝備 V 核心資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterVMatrix(ocid: string, dateOptions?: DateOptions): Promise<CharacterVMatrixDto>;
+    /**
+     * 檢視已裝備於 HEXA 矩陣的 HEXA 核心資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterHexaMatrix(ocid: string, dateOptions?: DateOptions): Promise<CharacterHexaMatrixDto>;
+    /**
+     * 檢視設定於 HEXA 矩陣中的 HEXA 屬性資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterHexaMatrixStat(ocid: string, dateOptions?: DateOptions): Promise<CharacterHexaMatrixStatDto>;
+    /**
+     * 檢視角色在武陵道場的最高紀錄資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterDojang(ocid: string, dateOptions?: DateOptions): Promise<CharacterDojangDto>;
+    /**
+     * 檢視戰地等級與戰地階級資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getUnion(ocid: string, dateOptions?: DateOptions): Promise<UnionDto>;
+    /**
+     * 檢視詳細資訊，例如派遣至聯盟的攻擊單位成員效果，以及攻擊單位佔領效果。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getUnionRaider(ocid: string, dateOptions?: DateOptions): Promise<UnionRaiderDto>;
+    /**
+     * 檢視戰地神器資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getUnionArtifact(ocid: string, dateOptions?: DateOptions): Promise<UnionArtifactDto>;
+    /**
+     * 檢視公會識別碼 (oguild_id) 資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param guildName 公會名稱
+     * @param worldName 世界名稱 <a href="https://openapi.nexon.com/game/maplestorytw/?id=51">Available values</a>
+     */
+    getGuild(guildName: string, worldName: string): Promise<GuildDto>;
+    /**
+     * 檢視公會基本資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param guildId 公會識別碼
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getGuildBasic(guildId: string, dateOptions?: DateOptions): Promise<GuildBasicDto>;
+}
+type CharacterImageOptions = {
+    /**
+     * 角色動作
+     */
+    action?: CharacterImageAction;
+    /**
+     * 角色表情
+     */
+    emotion?: CharacterImageEmotion;
+    /**
+     * 角色武器動作
+     */
+    wmotion?: CharacterImageWeaponMotion;
+    /**
+     * 角色動作影格
+     */
+    actionFrame?: number;
+    /**
+     * 角色表情影格
+     */
+    emotionFrame?: number;
+    /**
+     * 寬度 (對應背景大小，96 (預設) 至 1000)
+     */
+    width?: number;
+    /**
+     * 高度 (對應背景大小，96 (預設) 至 1000)
+     */
+    height?: number;
+    /**
+     * 角色的水平座標 (座標範圍 0 < x < 寬度，0 對應至最左起點)
+     */
+    x?: number;
+    /**
+     * 角色的垂直座標 (座標範圍 0 < y < 高度，0 對應至最上方起點)
+     */
+    y?: number;
+};
+export {};

package/types/maplestory/api/tms/response/character/characterAbilityBody.d.ts

@@ -0,0 +1,19 @@
+export type CharacterAbilityBody = {
+    date: string | null;
+    ability_grade: string | null;
+    ability_info: CharacterAbilityInfoBody[];
+    remain_fame: number | null;
+    preset_no: number | null;
+    ability_preset_1: CharacterAbilityPresetBody | null;
+    ability_preset_2: CharacterAbilityPresetBody | null;
+    ability_preset_3: CharacterAbilityPresetBody | null;
+};
+export type CharacterAbilityInfoBody = {
+    ability_no: string;
+    ability_grade: string;
+    ability_value: string;
+};
+export type CharacterAbilityPresetBody = {
+    ability_preset_grade: string;
+    ability_info: CharacterAbilityInfoBody[];
+};

package/types/maplestory/api/tms/response/character/characterAndroidEquipmentBody.d.ts

@@ -0,0 +1,76 @@
+export type CharacterAndroidEquipmentBody = {
+    date: string | null;
+    android_name: string | null;
+    android_nickname: string | null;
+    android_icon: string | null;
+    android_description: string | null;
+    android_hair: CharacterAndroidEquipmentHairBody | null;
+    android_face: CharacterAndroidEquipmentFaceBody | null;
+    android_skin: CharacterAndroidEquipmentSkinBody | null;
+    android_cash_item_equipment: CharacterAndroidCashItemEquipmentBody[];
+    android_ear_sensor_clip_flag: string | null;
+    android_gender: string | null;
+    android_grade: string | null;
+    android_non_humanoid_flag: string | null;
+    android_shop_usable_flag: string | null;
+    preset_no: number | null;
+    android_preset_1: CharacterAndroidEquipmentPresetBody | null;
+    android_preset_2: CharacterAndroidEquipmentPresetBody | null;
+    android_preset_3: CharacterAndroidEquipmentPresetBody | null;
+};
+export type CharacterAndroidEquipmentHairBody = {
+    hair_name: string | null;
+    base_color: string | null;
+    mix_color: string | null;
+    mix_rate: string;
+};
+export type CharacterAndroidEquipmentFaceBody = {
+    face_name: string | null;
+    base_color: string | null;
+    mix_color: string | null;
+    mix_rate: string;
+};
+export type CharacterAndroidEquipmentSkinBody = {
+    skin_name: string;
+    color_style: string | null;
+    hue: number | null;
+    saturation: number | null;
+    brightness: number | null;
+};
+export type CharacterAndroidEquipmentPresetBody = {
+    android_name: string;
+    android_nickname: string;
+    android_icon: string;
+    android_description: string;
+    android_gender: string | null;
+    android_grade: string;
+    android_hair: CharacterAndroidEquipmentHairBody;
+    android_face: CharacterAndroidEquipmentFaceBody;
+    android_skin: CharacterAndroidEquipmentSkinBody | null;
+    android_ear_sensor_clip_flag: string;
+    android_non_humanoid_flag: string;
+    android_shop_usable_flag: string;
+};
+export type CharacterAndroidCashItemEquipmentBody = {
+    cash_item_equipment_part: string;
+    cash_item_equipment_slot: string;
+    cash_item_name: string;
+    cash_item_icon: string;
+    cash_item_description: string | null;
+    cash_item_option: CharacterAndroidCashItemEquipmentOptionBody[];
+    date_expire: string | null;
+    date_option_expire: string | null;
+    cash_item_label: string | null;
+    cash_item_coloring_prism: CharacterAndroidCashItemEquipmentColoringPrismBody | null;
+    android_item_gender: string | null;
+};
+export type CharacterAndroidCashItemEquipmentOptionBody = {
+    option_type: string;
+    option_value: string;
+};
+export type CharacterAndroidCashItemEquipmentColoringPrismBody = {
+    color_range: string;
+    hue: number;
+    saturation: number;
+    value: number;
+};

package/types/maplestory/api/tms/response/character/characterBasicBody.d.ts

@@ -0,0 +1,16 @@
+export type CharacterBasicBody = {
+    date: string | null;
+    character_name: string;
+    world_name: string;
+    character_gender: string;
+    character_class: string;
+    character_class_level: string;
+    character_level: number;
+    character_exp: number;
+    character_exp_rate: string;
+    character_guild_name: string | null;
+    character_image: string;
+    character_date_create: string;
+    access_flag: 'true' | 'false';
+    liberation_quest_clear: string;
+};

package/types/maplestory/api/tms/response/character/characterBeautyEquipmentBody.d.ts

@@ -0,0 +1,30 @@
+export type CharacterBeautyEquipmentBody = {
+    date: string | null;
+    character_gender: string;
+    character_class: string;
+    character_hair: CharacterBeautyEquipmentHairBody | null;
+    character_face: CharacterBeautyEquipmentFaceBody | null;
+    character_skin: CharacterBeautyEquipmentSkinBody | null;
+    additional_character_hair: CharacterBeautyEquipmentHairBody | null;
+    additional_character_face: CharacterBeautyEquipmentFaceBody | null;
+    additional_character_skin: CharacterBeautyEquipmentSkinBody | null;
+};
+export type CharacterBeautyEquipmentHairBody = {
+    hair_name: string;
+    base_color: string;
+    mix_color: string | null;
+    mix_rate: string;
+};
+export type CharacterBeautyEquipmentFaceBody = {
+    face_name: string;
+    base_color: string;
+    mix_color: string | null;
+    mix_rate: string;
+};
+export type CharacterBeautyEquipmentSkinBody = {
+    skin_name: string;
+    color_style: string | null;
+    hue: number | null;
+    saturation: number | null;
+    brightness: number | null;
+};

package/types/maplestory/api/tms/response/character/characterBody.d.ts

@@ -0,0 +1,3 @@
+export type CharacterBody = {
+    ocid: string;
+};

package/types/maplestory/api/tms/response/character/characterCashItemEquipmentBody.d.ts

@@ -0,0 +1,39 @@
+export type CharacterCashItemEquipmentBody = {
+    date: string | null;
+    character_gender: string | null;
+    character_class: string | null;
+    character_look_mode: string | null;
+    preset_no: number | null;
+    cash_item_equipment_base: CharacterCashItemEquipmentPresetBody[];
+    cash_item_equipment_preset_1: CharacterCashItemEquipmentPresetBody[];
+    cash_item_equipment_preset_2: CharacterCashItemEquipmentPresetBody[];
+    cash_item_equipment_preset_3: CharacterCashItemEquipmentPresetBody[];
+    additional_cash_item_equipment_base: CharacterCashItemEquipmentPresetBody[];
+    additional_cash_item_equipment_preset_1: CharacterCashItemEquipmentPresetBody[];
+    additional_cash_item_equipment_preset_2: CharacterCashItemEquipmentPresetBody[];
+    additional_cash_item_equipment_preset_3: CharacterCashItemEquipmentPresetBody[];
+};
+export type CharacterCashItemEquipmentPresetBody = {
+    cash_item_equipment_part: string;
+    cash_item_equipment_slot: string;
+    cash_item_name: string;
+    cash_item_icon: string;
+    cash_item_description: string | null;
+    cash_item_option: CharacterCashItemEquipmentOptionBody[];
+    date_expire: string | null;
+    date_option_expire: string | null;
+    cash_item_label: string | null;
+    cash_item_coloring_prism: CharacterCashItemEquipmentColoringPrismBody | null;
+    item_gender: string | null;
+    skills: string[];
+};
+export type CharacterCashItemEquipmentOptionBody = {
+    option_type: string;
+    option_value: string;
+};
+export type CharacterCashItemEquipmentColoringPrismBody = {
+    color_range: string;
+    hue: number;
+    saturation: number;
+    value: number;
+};

package/types/maplestory/api/tms/response/character/characterDojangBody.d.ts

@@ -0,0 +1,8 @@
+export type CharacterDojangBody = {
+    date: string | null;
+    character_class: string | null;
+    world_name: string | null;
+    dojang_best_floor: number | null;
+    date_dojang_record: string | null;
+    dojang_best_time: number | null;
+};

package/types/maplestory/api/tms/response/character/characterHexaMatrixBody.d.ts

@@ -0,0 +1,13 @@
+export type CharacterHexaMatrixBody = {
+    date: string | null;
+    character_hexa_core_equipment: CharacterHexaMatrixEquipmentBody[] | null;
+};
+export type CharacterHexaMatrixEquipmentBody = {
+    hexa_core_name: string;
+    hexa_core_level: number;
+    hexa_core_type: string;
+    linked_skill: CharacterHexaMatrixEquipmentLinkedSkillBody[];
+};
+export type CharacterHexaMatrixEquipmentLinkedSkillBody = {
+    hexa_skill_id: string;
+};

package/types/maplestory/api/tms/response/character/characterHexaMatrixStatBody.d.ts

@@ -0,0 +1,20 @@
+export type CharacterHexaMatrixStatBody = {
+    date: string | null;
+    character_class: string | null;
+    character_hexa_stat_core: CharacterHexaMatrixStatCoreBody[] | null;
+    character_hexa_stat_core_2: CharacterHexaMatrixStatCoreBody[] | null;
+    character_hexa_stat_core_3: CharacterHexaMatrixStatCoreBody[] | null;
+    preset_hexa_stat_core: CharacterHexaMatrixStatCoreBody[] | null;
+    preset_hexa_stat_core_2: CharacterHexaMatrixStatCoreBody[] | null;
+    preset_hexa_stat_core_3: CharacterHexaMatrixStatCoreBody[] | null;
+};
+export type CharacterHexaMatrixStatCoreBody = {
+    slot_id: string;
+    main_stat_name: string;
+    sub_stat_name_1: string;
+    sub_stat_name_2: string;
+    main_stat_level: number;
+    sub_stat_level_1: number;
+    sub_stat_level_2: number;
+    stat_grade: number;
+};

package/types/maplestory/api/tms/response/character/characterHyperStatBody.d.ts

@@ -0,0 +1,18 @@
+export type CharacterHyperStatBody = {
+    date: string | null;
+    character_class: string | null;
+    use_preset_no: string | null;
+    use_available_hyper_stat: number | null;
+    hyper_stat_preset_1: CharacterHyperStatPresetBody[];
+    hyper_stat_preset_1_remain_point: number | null;
+    hyper_stat_preset_2: CharacterHyperStatPresetBody[];
+    hyper_stat_preset_2_remain_point: number | null;
+    hyper_stat_preset_3: CharacterHyperStatPresetBody[];
+    hyper_stat_preset_3_remain_point: number | null;
+};
+export type CharacterHyperStatPresetBody = {
+    stat_type: string;
+    stat_point: number | null;
+    stat_level: number;
+    stat_increase: string | null;
+};