maplestory-openapi 3.6.0 → 3.8.0

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

@@ -23,12 +23,14 @@ export type CharacterAndroidEquipmentHairBody = {
     base_color: string | null;
     mix_color: string | null;
     mix_rate: string;
+    freestyle_flag: string | null;
 };
 export type CharacterAndroidEquipmentFaceBody = {
     face_name: string | null;
     base_color: string | null;
     mix_color: string | null;
     mix_rate: string;
+    freestyle_flag: string | null;
 };
 export type CharacterAndroidEquipmentSkinBody = {
     skin_name: string;
@@ -63,6 +65,7 @@ export type CharacterAndroidCashItemEquipmentBody = {
     cash_item_label: string | null;
     cash_item_coloring_prism: CharacterAndroidCashItemEquipmentColoringPrismBody | null;
     android_item_gender: string | null;
+    freestyle_flag: string | null;
 };
 export type CharacterAndroidCashItemEquipmentOptionBody = {
     option_type: string;

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

@@ -12,5 +12,5 @@ export type CharacterBasicBody = {
     character_image: string;
     character_date_create: string | null;
     access_flag: 'true' | 'false';
-    liberation_quest_clear_flag: 'true' | 'false';
+    liberation_quest_clear: string;
 };

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

@@ -14,12 +14,14 @@ export type CharacterBeautyEquipmentHairBody = {
     base_color: string;
     mix_color: string | null;
     mix_rate: string;
+    freestyle_flag: string | null;
 };
 export type CharacterBeautyEquipmentFaceBody = {
     face_name: string;
     base_color: string;
     mix_color: string | null;
     mix_rate: string;
+    freestyle_flag: string | null;
 };
 export type CharacterBeautyEquipmentSkinBody = {
     skin_name: string;

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

@@ -25,6 +25,8 @@ export type CharacterCashItemEquipmentPresetBody = {
     cash_item_label: string | null;
     cash_item_coloring_prism: CharacterCashItemEquipmentColoringPrismBody | null;
     item_gender: string | null;
+    skills: string[];
+    freestyle_flag: string | null;
 };
 export type CharacterCashItemEquipmentOptionBody = {
     option_type: string;

package/types/maplestory/api/msea/response/character/characterItemEquipmentBody.d.ts

@@ -8,6 +8,7 @@ export type CharacterItemEquipmentBody = {
     item_equipment_preset_2: CharacterItemEquipmentInfoBody[] | null;
     item_equipment_preset_3: CharacterItemEquipmentInfoBody[] | null;
     title: CharacterItemEquipmentTitleBody | null;
+    medal_shape: CharacterItemEquipmentMedalShapeBody | null;
     dragon_equipment: CharacterItemEquipmentDragonInfoBody[];
     mechanic_equipment: CharacterItemEquipmentMechanicInfoBody[];
 };
@@ -50,6 +51,7 @@ export type CharacterItemEquipmentInfoBody = {
     item_starforce_option: CharacterItemEquipmentStarforceOptionBody;
     special_ring_level: number;
     date_expire: string | null;
+    freestyle_flag: string | null;
 };
 export type CharacterItemEquipmentMechanicInfoBody = {
     item_equipment_part: string;
@@ -80,6 +82,7 @@ export type CharacterItemEquipmentMechanicInfoBody = {
     item_starforce_option: CharacterItemEquipmentOptionBody;
     special_ring_level: number;
     date_expire: string | null;
+    freestyle_flag: string | null;
 };
 export type CharacterItemEquipmentDragonInfoBody = CharacterItemEquipmentMechanicInfoBody;
 export type CharacterItemEquipmentOptionBody = {
@@ -189,4 +192,15 @@ export type CharacterItemEquipmentTitleBody = {
     title_description: string | null;
     date_expire: string | null;
     date_option_expire: string | null;
+    title_shape_name: string | null;
+    title_shape_icon: string | null;
+    title_shape_description: string | null;
+};
+export type CharacterItemEquipmentMedalShapeBody = {
+    medal_shape_name: string;
+    medal_shape_icon: string;
+    medal_shape_description: string;
+    medal_shape_changed_name: string;
+    medal_shape_changed_icon: string;
+    medal_shape_changed_description: string;
 };

package/types/maplestory/api/msea/response/union/unionChampionBody.d.ts

@@ -0,0 +1,15 @@
+export type UnionChampionBody = {
+    date: string;
+    union_champion: UnionChampionInfoBody[];
+    champion_badge_total_info: UnionChampionBadgeInfoBody[];
+};
+export type UnionChampionInfoBody = {
+    champion_name: string;
+    champion_slot: number;
+    champion_grade: string;
+    champion_class: string;
+    champion_badge_info: UnionChampionBadgeInfoBody[];
+};
+export type UnionChampionBadgeInfoBody = {
+    stat: string;
+};

package/types/maplestory/api/tms/dto/character/characterAndroidEquipment.d.ts

@@ -98,7 +98,15 @@ export declare class CharacterAndroidEquipmentFaceDto extends base.CharacterAndr
      * 機器人臉型混染顏色比例
      */
     mixRate: string;
+    /**
+     * 自由造型券 使用狀態（0：未使用，1：已使用）
+     */
+    freestyleFlag: string | null;
     constructor(obj: CharacterAndroidEquipmentFaceBody);
+    /**
+     * 自由造型券 使用狀態
+     */
+    get isFreestyleFlag(): boolean;
 }
 /**
  * 機器人髮型資訊
@@ -120,7 +128,15 @@ export declare class CharacterAndroidEquipmentHairDto extends base.CharacterAndr
      * 機器人髮型混染顏色比例
      */
     mixRate: string;
+    /**
+     * 自由造型券 使用狀態（0：未使用，1：已使用）
+     */
+    freestyleFlag: string | null;
     constructor(obj: CharacterAndroidEquipmentHairBody);
+    /**
+     * 自由造型券 使用狀態
+     */
+    get isFreestyleFlag(): boolean;
 }
 /**
  * 機器人膚色資訊
@@ -295,5 +311,13 @@ export declare class CharacterAndroidCashItemEquipmentDto extends base.Character
      * 道具可裝備性別
      */
     androidItemGender: string | null;
+    /**
+     * 自由造型券 使用狀態（0：未使用，1：已使用）
+     */
+    freestyleFlag: string | null;
     constructor(obj: CharacterAndroidCashItemEquipmentBody);
+    /**
+     * 自由造型券 使用狀態
+     */
+    get isFreestyleFlag(): boolean;
 }

package/types/maplestory/api/tms/dto/character/characterBasic.d.ts

@@ -57,7 +57,7 @@ export declare class CharacterBasicDto extends base.CharacterBasicDto {
      */
     accessFlag: 'true' | 'false';
     /**
-     * 解放任務完成狀態 (0：未完成，1：創世武器已解放)
+     * 解放任務完成狀態 (0：未完成，1：創世武器已解放, 2:命運武器第一階段解放)
      */
     liberationQuestClear: string;
     constructor(obj: CharacterBasicBody);

package/types/maplestory/api/tms/dto/character/characterBeautyEquipment.d.ts

@@ -65,7 +65,15 @@ export declare class CharacterBeautyEquipmentFaceDto extends base.CharacterBeaut
      * 臉型混染顏色比例
      */
     mixRate: string;
+    /**
+     * 自由造型券 使用狀態（0：未使用，1：已使用）
+     */
+    freestyleFlag: string | null;
     constructor(obj: CharacterBeautyEquipmentFaceBody);
+    /**
+     * 自由造型券 使用狀態
+     */
+    get isFreestyleFlag(): boolean;
 }
 /**
  * 角色髮型資訊
@@ -87,7 +95,15 @@ export declare class CharacterBeautyEquipmentHairDto extends base.CharacterBeaut
      * 髮型混染顏色比例
      */
     mixRate: string;
+    /**
+     * 自由造型券 使用狀態（0：未使用，1：已使用）
+     */
+    freestyleFlag: string | null;
     constructor(obj: CharacterBeautyEquipmentHairBody);
+    /**
+     * 自由造型券 使用狀態
+     */
+    get isFreestyleFlag(): boolean;
 }
 /**
  * 角色膚色資訊

package/types/maplestory/api/tms/dto/character/characterCashItemEquipment.d.ts

@@ -154,5 +154,13 @@ export declare class CharacterCashItemEquipmentPresetDto extends base.CharacterC
      * 技能名稱
      */
     skills: string[];
+    /**
+     * 自由造型券 使用狀態（0：未使用，1：已使用）
+     */
+    freestyleFlag: string | null;
     constructor(obj: CharacterCashItemEquipmentPresetBody);
+    /**
+     * 自由造型券 使用狀態
+     */
+    get isFreestyleFlag(): boolean;
 }

package/types/maplestory/api/tms/dto/character/characterItemEquipment.d.ts

@@ -1,5 +1,5 @@
 import * as base from '../../../common/dto/character/characterItemEquipment';
-import { CharacterItemEquipmentAddOptionBody, CharacterItemEquipmentBaseOptionBody, CharacterItemEquipmentBody, CharacterItemEquipmentDragonInfoBody, CharacterItemEquipmentEtcOptionBody, CharacterItemEquipmentExceptionalOptionBody, CharacterItemEquipmentInfoBody, CharacterItemEquipmentMechanicInfoBody, CharacterItemEquipmentStarforceOptionBody, CharacterItemEquipmentTitleBody, CharacterItemEquipmentTotalOptionBody } from '../../response/character/characterItemEquipmentBody';
+import { CharacterItemEquipmentAddOptionBody, CharacterItemEquipmentBaseOptionBody, CharacterItemEquipmentBody, CharacterItemEquipmentDragonInfoBody, CharacterItemEquipmentEtcOptionBody, CharacterItemEquipmentExceptionalOptionBody, CharacterItemEquipmentInfoBody, CharacterItemEquipmentMechanicInfoBody, CharacterItemEquipmentMedalShapeBody, CharacterItemEquipmentStarforceOptionBody, CharacterItemEquipmentTitleBody, CharacterItemEquipmentTotalOptionBody } from '../../response/character/characterItemEquipmentBody';
 /**
  * 角色已裝備道具資訊
  */
@@ -40,6 +40,10 @@ export declare class CharacterItemEquipmentDto extends base.CharacterItemEquipme
      * 稱號資訊
      */
     title: CharacterItemEquipmentTitleDto | null;
+    /**
+     * 外型設定中已登錄勳章的外型資訊
+     */
+    medalShape: CharacterItemEquipmentMedalShapeDto | null;
     /**
      * 龍魔導士的龍道具資訊 (僅在龍魔導士時回應)
      */
@@ -96,6 +100,36 @@ export declare class CharacterItemEquipmentTitleDto extends base.CharacterItemEq
     titleShapeDescription: string | null;
     constructor(obj: CharacterItemEquipmentTitleBody);
 }
+/**
+ * 外型設定中已登錄勳章的外型資訊
+ */
+export declare class CharacterItemEquipmentMedalShapeDto extends base.CharacterItemEquipmentMedalShapeDto {
+    /**
+     * 外型設定中已登錄勳章的道具名稱
+     */
+    medalShapeName: string;
+    /**
+     * 外型設定中已登錄勳章的圖示
+     */
+    medalShapeIcon: string;
+    /**
+     * 外型設定中已登錄勳章的描述
+     */
+    medalShapeDescription: string;
+    /**
+     * 外型設定中已登錄勳章的鐵砧套用道具名稱
+     */
+    medalShapeChangedName: string;
+    /**
+     * 外型設定中已登錄勳章的鐵砧套用圖示
+     */
+    medalShapeChangedIcon: string;
+    /**
+     * 外型設定中已登錄勳章的鐵砧套用勳章說明
+     */
+    medalShapeChangedDescription: string;
+    constructor(obj: CharacterItemEquipmentMedalShapeBody);
+}
 /**
  * 附加道具選項
  */
@@ -576,7 +610,15 @@ export declare class CharacterItemEquipmentDragonInfoDto extends base.CharacterI
      * Whether the equipment is expired
      */
     isExpired: boolean | null;
+    /**
+     * 自由造型券 使用狀態（0：未使用，1：已使用）
+     */
+    freestyleFlag: string | null;
     constructor(obj: CharacterItemEquipmentDragonInfoBody);
+    /**
+     * 自由造型券 使用狀態
+     */
+    get isFreestyleFlag(): boolean;
 }
 /**
  * 機甲戰神道具資訊
@@ -698,7 +740,15 @@ export declare class CharacterItemEquipmentMechanicInfoDto extends base.Characte
      * Whether the equipment is expired
      */
     isExpired: boolean | null;
+    /**
+     * 自由造型券 使用狀態（0：未使用，1：已使用）
+     */
+    freestyleFlag: string | null;
     constructor(obj: CharacterItemEquipmentMechanicInfoBody);
+    /**
+     * 自由造型券 使用狀態
+     */
+    get isFreestyleFlag(): boolean;
 }
 /**
  * 道具資訊
@@ -860,5 +910,13 @@ export declare class CharacterItemEquipmentInfoDto extends base.CharacterItemEqu
      * Whether the equipment is expired
      */
     isExpired: boolean | null;
+    /**
+     * 自由造型券 使用狀態（0：未使用，1：已使用）
+     */
+    freestyleFlag: string | null;
     constructor(obj: CharacterItemEquipmentInfoBody);
+    /**
+     * 自由造型券 使用狀態
+     */
+    get isFreestyleFlag(): boolean;
 }

package/types/maplestory/api/tms/dto/union/unionChampion.d.ts

@@ -0,0 +1,53 @@
+import * as base from '../../../common/dto/union/unionChampion';
+import { UnionChampionBadgeInfoBody, UnionChampionBody, UnionChampionInfoBody } from '../../response/union/unionChampionBody';
+/**
+ * 聯盟冠軍資訊
+ */
+export declare class UnionChampionDto extends base.UnionChampionDto {
+    date: Date | null;
+    /**
+     * 聯盟冠軍資訊
+     */
+    unionChampion: UnionChampionInfoDto[];
+    /**
+     * 冠軍徽章效果
+     */
+    championBadgeTotalInfo: UnionChampionBadgeInfoDto[];
+    constructor(obj: UnionChampionBody);
+}
+/**
+ * 聯盟冠軍徽章資訊
+ */
+export declare class UnionChampionBadgeInfoDto extends base.UnionChampionBadgeInfoDto {
+    /**
+     * 聯盟冠軍徽章資訊
+     */
+    stat: string;
+    constructor(obj: UnionChampionBadgeInfoBody);
+}
+/**
+ * 聯盟冠軍資訊
+ */
+export declare class UnionChampionInfoDto extends base.UnionChampionInfoDto {
+    /**
+     * 聯盟冠軍角色名稱
+     */
+    championName: string;
+    /**
+     * 聯盟冠軍欄位
+     */
+    championSlot: number;
+    /**
+     * 聯盟冠軍等級
+     */
+    championGrade: string;
+    /**
+     * 聯盟冠軍角色職業
+     */
+    championClass: string;
+    /**
+     * 聯盟冠軍徽章資訊
+     */
+    championBadgeInfo: UnionChampionBadgeInfoDto[];
+    constructor(obj: UnionChampionInfoBody);
+}

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

@@ -24,4 +24,5 @@ export * from './dto/guild/guild';
 export * from './dto/guild/guildBasic';
 export * from './dto/union/union';
 export * from './dto/union/unionArtifact';
+export * from './dto/union/unionChampion';
 export * from './dto/union/unionRaider';

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

@@ -23,6 +23,7 @@ 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 { UnionChampionDto } from './dto/union/unionChampion';
 import { UnionRaiderDto } from './dto/union/unionRaider';
 import { CharacterImageAction, CharacterImageEmotion, CharacterImageWeaponMotion } from '../common/enum/characterImage';
 import { DateOptions } from '../common/mapleStoryApi';
@@ -300,6 +301,17 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
      * @param dateOptions 要搜尋的日期 (TST)
      */
     getUnionArtifact(ocid: string, dateOptions?: DateOptions): Promise<UnionArtifactDto | null>;
+    /**
+     * 查詢聯盟冠軍資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 12 月 18 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getUnionChampion(ocid: string, dateOptions?: DateOptions): Promise<UnionChampionDto | null>;
     /**
      * 檢視公會識別碼 (oguild_id) 資訊。
      * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。

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

@@ -23,12 +23,14 @@ export type CharacterAndroidEquipmentHairBody = {
     base_color: string | null;
     mix_color: string | null;
     mix_rate: string;
+    freestyle_flag: string | null;
 };
 export type CharacterAndroidEquipmentFaceBody = {
     face_name: string | null;
     base_color: string | null;
     mix_color: string | null;
     mix_rate: string;
+    freestyle_flag: string | null;
 };
 export type CharacterAndroidEquipmentSkinBody = {
     skin_name: string;
@@ -63,6 +65,7 @@ export type CharacterAndroidCashItemEquipmentBody = {
     cash_item_label: string | null;
     cash_item_coloring_prism: CharacterAndroidCashItemEquipmentColoringPrismBody | null;
     android_item_gender: string | null;
+    freestyle_flag: string | null;
 };
 export type CharacterAndroidCashItemEquipmentOptionBody = {
     option_type: string;

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

@@ -14,12 +14,14 @@ export type CharacterBeautyEquipmentHairBody = {
     base_color: string;
     mix_color: string | null;
     mix_rate: string;
+    freestyle_flag: string | null;
 };
 export type CharacterBeautyEquipmentFaceBody = {
     face_name: string;
     base_color: string;
     mix_color: string | null;
     mix_rate: string;
+    freestyle_flag: string | null;
 };
 export type CharacterBeautyEquipmentSkinBody = {
     skin_name: string;

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

@@ -26,6 +26,7 @@ export type CharacterCashItemEquipmentPresetBody = {
     cash_item_coloring_prism: CharacterCashItemEquipmentColoringPrismBody | null;
     item_gender: string | null;
     skills: string[];
+    freestyle_flag: string | null;
 };
 export type CharacterCashItemEquipmentOptionBody = {
     option_type: string;

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

@@ -8,6 +8,7 @@ export type CharacterItemEquipmentBody = {
     item_equipment_preset_2: CharacterItemEquipmentInfoBody[] | null;
     item_equipment_preset_3: CharacterItemEquipmentInfoBody[] | null;
     title: CharacterItemEquipmentTitleBody | null;
+    medal_shape: CharacterItemEquipmentMedalShapeBody | null;
     dragon_equipment: CharacterItemEquipmentDragonInfoBody[];
     mechanic_equipment: CharacterItemEquipmentMechanicInfoBody[];
 };
@@ -50,6 +51,7 @@ export type CharacterItemEquipmentInfoBody = {
     item_starforce_option: CharacterItemEquipmentStarforceOptionBody;
     special_ring_level: number;
     date_expire: string | null;
+    freestyle_flag: string | null;
 };
 export type CharacterItemEquipmentMechanicInfoBody = {
     item_equipment_part: string;
@@ -80,6 +82,7 @@ export type CharacterItemEquipmentMechanicInfoBody = {
     item_starforce_option: CharacterItemEquipmentOptionBody;
     special_ring_level: number;
     date_expire: string | null;
+    freestyle_flag: string | null;
 };
 export type CharacterItemEquipmentDragonInfoBody = CharacterItemEquipmentMechanicInfoBody;
 export type CharacterItemEquipmentOptionBody = {
@@ -193,3 +196,11 @@ export type CharacterItemEquipmentTitleBody = {
     title_shape_icon: string | null;
     title_shape_description: string | null;
 };
+export type CharacterItemEquipmentMedalShapeBody = {
+    medal_shape_name: string;
+    medal_shape_icon: string;
+    medal_shape_description: string;
+    medal_shape_changed_name: string;
+    medal_shape_changed_icon: string;
+    medal_shape_changed_description: string;
+};

package/types/maplestory/api/tms/response/union/unionChampionBody.d.ts

@@ -0,0 +1,15 @@
+export type UnionChampionBody = {
+    date: string;
+    union_champion: UnionChampionInfoBody[];
+    champion_badge_total_info: UnionChampionBadgeInfoBody[];
+};
+export type UnionChampionInfoBody = {
+    champion_name: string;
+    champion_slot: number;
+    champion_grade: string;
+    champion_class: string;
+    champion_badge_info: UnionChampionBadgeInfoBody[];
+};
+export type UnionChampionBadgeInfoBody = {
+    stat: string;
+};