maplestory-openapi 3.9.0 → 3.11.0

package/types/maplestory/api/kms/response/battlePractice/battlePracticeResultBody.d.ts

@@ -0,0 +1,20 @@
+export type BattlePracticeResultBody = {
+    register_date: string;
+    total_play_time: number;
+    total_damage: number;
+    total_dps: number;
+    end_type: string;
+    like_count: number;
+    skill_statistic: BattlePracticeSkillStatisticBody[];
+};
+export type BattlePracticeSkillStatisticBody = {
+    skill_name: string;
+    damage: number;
+    damage_percent: string;
+    dps: number;
+    use_count: number;
+    damage_per_use: number;
+    attack_count: number;
+    max_damage: number;
+    min_damage: number;
+};

package/types/maplestory/api/kms/response/battlePractice/battlePracticeSkillTimelineBody.d.ts

@@ -0,0 +1,12 @@
+export type BattlePracticeSkillTimelineBody = {
+    page_no: number;
+    total_page_no: number;
+    skill_timeline: BattlePracticeSkillTimelineEventBody[];
+};
+export type BattlePracticeSkillTimelineEventBody = {
+    elapse_time: number;
+    skill_name: string;
+    hexa_skill_specificity_flag: string;
+    sequence_name: string | null;
+    sequence_key: string | null;
+};

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

@@ -5,6 +5,7 @@ export type CharacterHexaMatrixBody = {
 export type CharacterHexaMatrixEquipmentBody = {
     hexa_core_name: string;
     hexa_core_level: number;
+    hexa_core_event_level: number;
     hexa_core_type: string;
     linked_skill: CharacterHexaMatrixEquipmentLinkedSkillBody[];
 };

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

@@ -187,6 +187,20 @@ export type CharacterItemEquipmentEtcOptionBody = {
 };
 export type CharacterItemEquipmentStarforceOptionBody = CharacterItemEquipmentEtcOptionBody;
 export type CharacterItemEquipmentTitleBody = {
+    preset_no: number | null;
+    title_name: string | null;
+    title_icon: string | null;
+    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;
+    title_preset_1: CharacterItemEquipmentTitlePresetBody | null;
+    title_preset_2: CharacterItemEquipmentTitlePresetBody | null;
+    title_preset_3: CharacterItemEquipmentTitlePresetBody | null;
+};
+export type CharacterItemEquipmentTitlePresetBody = {
     title_name: string | null;
     title_icon: string | null;
     title_description: string | null;
@@ -195,6 +209,7 @@ export type CharacterItemEquipmentTitleBody = {
     title_shape_name: string | null;
     title_shape_icon: string | null;
     title_shape_description: string | null;
+    disable_flag: string | null;
 };
 export type CharacterItemEquipmentMedalShapeBody = {
     medal_shape_name: string;

package/types/maplestory/api/kms/response/character/characterPetEquipmentBody.d.ts

@@ -1,5 +1,6 @@
 export type CharacterPetEquipmentBody = {
     date: string | null;
+    pet_activate_flag: string | null;
     pet_1_name: string | null;
     pet_1_nickname: string | null;
     pet_1_icon: string | null;
@@ -33,6 +34,40 @@ export type CharacterPetEquipmentBody = {
     pet_3_date_expire: string | null;
     pet_3_appearance: string | null;
     pet_3_appearance_icon: string | null;
+    world_share_pet_1_name: string | null;
+    world_share_pet_1_nickname: string | null;
+    world_share_pet_1_icon: string | null;
+    world_share_pet_1_description: string | null;
+    world_share_pet_1_pet_type: string | null;
+    world_share_pet_1_equipment: CharacterPetEquipmentItemBody | null;
+    world_share_pet_1_auto_skill: CharacterPetEquipmentAutoSkillBody | null;
+    world_share_pet_1_skill: string[];
+    world_share_pet_1_date_expire: string | null;
+    world_share_pet_1_appearance: string | null;
+    world_share_pet_1_appearance_icon: string | null;
+    world_share_pet_2_name: string | null;
+    world_share_pet_2_nickname: string | null;
+    world_share_pet_2_icon: string | null;
+    world_share_pet_2_description: string | null;
+    world_share_pet_2_pet_type: string | null;
+    world_share_pet_2_equipment: CharacterPetEquipmentItemBody | null;
+    world_share_pet_2_auto_skill: CharacterPetEquipmentAutoSkillBody | null;
+    world_share_pet_2_skill: string[];
+    world_share_pet_2_date_expire: string | null;
+    world_share_pet_2_appearance: string | null;
+    world_share_pet_2_appearance_icon: string | null;
+    world_share_pet_3_name: string | null;
+    world_share_pet_3_nickname: string | null;
+    world_share_pet_3_icon: string | null;
+    world_share_pet_3_description: string | null;
+    world_share_pet_3_pet_type: string | null;
+    world_share_pet_3_equipment: CharacterPetEquipmentItemBody | null;
+    world_share_pet_3_auto_skill: CharacterPetEquipmentAutoSkillBody | null;
+    world_share_pet_3_skill: string[];
+    world_share_pet_3_date_expire: string | null;
+    world_share_pet_3_appearance: string | null;
+    world_share_pet_3_appearance_icon: string | null;
+    petite_luna_pet_skill: CharacterPetEquipmentPetiteLunaPetSkillBody[];
 };
 export type CharacterPetEquipmentItemBody = {
     item_name: string | null;
@@ -55,3 +90,9 @@ export type CharacterPetEquipmentAutoSkillBody = {
     skill_2: string | null;
     skill_2_icon: string | null;
 };
+export type CharacterPetEquipmentPetiteLunaPetSkillBody = {
+    skill_name: string | null;
+    skill_description: string | null;
+    skill_effect: string | null;
+    skill_icon: string | null;
+};

package/types/maplestory/api/kms/response/character/characterVMatrixBody.d.ts

@@ -3,6 +3,11 @@ export type CharacterVMatrixBody = {
     character_class: string | null;
     character_v_core_equipment: CharacterVMatrixCoreEquipmentDtoBody[];
     character_v_matrix_remain_slot_upgrade_point: number | null;
+    character_v_core_equipment_preset_1: CharacterVMatrixCoreEquipmentPresetBody[];
+    character_v_core_equipment_preset_2: CharacterVMatrixCoreEquipmentPresetBody[];
+    character_v_core_equipment_preset_3: CharacterVMatrixCoreEquipmentPresetBody[];
+    character_v_core_equipment_preset_4: CharacterVMatrixCoreEquipmentPresetBody[];
+    character_v_core_equipment_preset_5: CharacterVMatrixCoreEquipmentPresetBody[];
 };
 export type CharacterVMatrixCoreEquipmentDtoBody = {
     slot_id: string;
@@ -10,7 +15,12 @@ export type CharacterVMatrixCoreEquipmentDtoBody = {
     v_core_name: string | null;
     v_core_type: string | null;
     v_core_level: number;
-    v_core_skill_1: string;
+    v_core_skill_1: string | null;
     v_core_skill_2: string | null;
     v_core_skill_3: string | null;
 };
+export type CharacterVMatrixCoreEquipmentPresetBody = {
+    v_core_name: string | null;
+    v_core_type: string | null;
+    v_core_level: number;
+};

package/types/maplestory/api/kms/response/scheduler/schedulerCharacterStateBody.d.ts

@@ -0,0 +1,36 @@
+export type SchedulerCharacterStateBody = {
+    date: string | null;
+    character_name: string;
+    world_name: string;
+    character_level: number;
+    character_class: string;
+    daily_contents: SchedulerDailyContentBody[];
+    weekly_contents: SchedulerWeeklyContentBody[];
+    boss_contents: SchedulerBossContentBody[];
+    weekly_boss_clear_count: number;
+    weekly_boss_clear_limit_count: number;
+};
+export type SchedulerDailyContentBody = {
+    content_name: string;
+    type: string;
+    registration_flag: string;
+    now_count: number;
+    max_count: number;
+    quest_state: string | null;
+};
+export type SchedulerWeeklyContentBody = {
+    content_name: string;
+    type: string;
+    registration_flag: string;
+    now_count: number;
+    max_count: number;
+    quest_state: string | null;
+};
+export type SchedulerBossContentBody = {
+    content_name: string;
+    difficulty: string;
+    cycle: string;
+    list_order_no: number;
+    registration_flag: string;
+    complete_flag: string;
+};

package/types/maplestory/api/kms/response/union/unionRaiderBody.d.ts

@@ -10,6 +10,9 @@ export type UnionRaiderBody = {
     union_raider_preset_3: UnionRaiderPresetBody | null;
     union_raider_preset_4: UnionRaiderPresetBody | null;
     union_raider_preset_5: UnionRaiderPresetBody | null;
+    union_state_stat: string[];
+    union_state_stat_preset: UnionRaiderStateStatPresetBody[];
+    union_max_point: number | null;
 };
 export type UnionRaiderInnerStatBody = {
     stat_field_id: string;
@@ -36,3 +39,7 @@ export type UnionRaiderPresetBody = {
     union_inner_stat: UnionRaiderInnerStatBody[];
     union_block: UnionRaiderBlockBody[];
 };
+export type UnionRaiderStateStatPresetBody = {
+    preset_no: number;
+    union_state_stat: string[];
+};

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

@@ -0,0 +1,117 @@
+import { CharacterFamiliarBody, CharacterFamiliarInfoBody, CharacterFamiliarInfoOptionBody, CharacterFamiliarLinkSlotBody } from '../../response/character/characterFamiliarBody';
+/**
+ * 萌獸 資訊
+ */
+export declare class CharacterFamiliarDto {
+    /**
+     * 要搜尋的日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    date: Date | null;
+    /**
+     * 萌獸 鏈路插槽資訊
+     */
+    familiarLinkSlot: CharacterFamiliarLinkSlotDto[];
+    /**
+     * 萌獸 細節
+     */
+    familiarInfo: CharacterFamiliarInfoDto[];
+    constructor(obj: CharacterFamiliarBody);
+}
+/**
+ * 萌獸 鏈路插槽資訊
+ */
+export declare class CharacterFamiliarLinkSlotDto {
+    /**
+     * 插槽標識符 (1~3, vip)
+     */
+    slotId: string;
+    /**
+     * 連結的 萌獸 名稱 (如果插槽中沒有任何關聯，則為 null)
+     */
+    familiarName: string | null;
+    /**
+     * 已啟用還是未啟用 (true, false)
+     */
+    activeFlag: string;
+    /**
+     * 截止日期
+     */
+    expireDate: Date | null;
+    constructor(obj: CharacterFamiliarLinkSlotBody);
+}
+/**
+ * 萌獸 細節
+ */
+export declare class CharacterFamiliarInfoDto {
+    /**
+     * 萌獸 名稱
+     */
+    familiarName: string;
+    /**
+     * 萌獸 暱稱
+     */
+    familiarNickname: string;
+    /**
+     * 特別與否
+     */
+    familiarSpecialFlag: string;
+    /**
+     * 萌獸 情況
+     */
+    familiarState: string;
+    /**
+     * 等級
+     */
+    familiarLevel: number;
+    /**
+     * 經驗
+     */
+    familiarExp: number;
+    /**
+     * 具備的技能
+     */
+    skillName: string | null;
+    /**
+     * 選項等級
+     */
+    optionLevel: number;
+    /**
+     * 選項訊息
+     */
+    option: CharacterFamiliarInfoOptionDto[];
+    /**
+     * 等級
+     */
+    familiarGrade: string;
+    /**
+     * 外觀名稱
+     */
+    lookName: string | null;
+    /**
+     * 當前是否已被召喚
+     */
+    summonedFlag: string;
+    /**
+     * 連結槽索引 (1~3, vip, not link)
+     */
+    slotId: string;
+    constructor(obj: CharacterFamiliarInfoBody);
+}
+/**
+ * 選項訊息
+ */
+export declare class CharacterFamiliarInfoOptionDto {
+    /**
+     * 選項號
+     */
+    optionNo: number;
+    /**
+     * 選項名稱
+     */
+    optionName: string;
+    /**
+     * 選擇權價值
+     */
+    optionValue: string;
+    constructor(obj: CharacterFamiliarInfoOptionBody);
+}

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

@@ -1,5 +1,5 @@
 import * as base from '../../../common/dto/character/characterPetEquipment';
-import { CharacterPetEquipmentAutoSkillBody, CharacterPetEquipmentBody, CharacterPetEquipmentItemBody, CharacterPetEquipmentItemOptionBody } from '../../response/character/characterPetEquipmentBody';
+import { CharacterPetEquipmentAutoSkillBody, CharacterPetEquipmentBody, CharacterPetEquipmentItemBody, CharacterPetEquipmentItemOptionBody, CharacterPetEquipmentPotentialBody } from '../../response/character/characterPetEquipmentBody';
 /**
  * 角色已裝備寵物資訊
  */
@@ -56,6 +56,10 @@ export declare class CharacterPetEquipmentDto extends base.CharacterPetEquipment
      * 寵物 1 外型圖示
      */
     pet1AppearanceIcon: string | null;
+    /**
+     * 寵物1 潛在的
+     */
+    pet1Potential: CharacterPetEquipmentPotentialDto[];
     /**
      * 寵物 2 名稱
      */
@@ -104,6 +108,10 @@ export declare class CharacterPetEquipmentDto extends base.CharacterPetEquipment
      * 寵物 2 外型圖示
      */
     pet2AppearanceIcon: string | null;
+    /**
+     * 寵物2 潛在的
+     */
+    pet2Potential: CharacterPetEquipmentPotentialDto[];
     /**
      * 寵物 3 名稱
      */
@@ -152,6 +160,10 @@ export declare class CharacterPetEquipmentDto extends base.CharacterPetEquipment
      * 寵物 3 外型圖示
      */
     pet3AppearanceIcon: string | null;
+    /**
+     * 寵物3 潛在的
+     */
+    pet3Potential: CharacterPetEquipmentPotentialDto[];
     constructor(obj: CharacterPetEquipmentBody);
 }
 /**
@@ -228,3 +240,25 @@ export declare class CharacterPetEquipmentItemDto extends base.CharacterPetEquip
     itemShapeIcon: string | null;
     constructor(obj: CharacterPetEquipmentItemBody);
 }
+/**
+ * 寵物 潛在的
+ */
+export declare class CharacterPetEquipmentPotentialDto {
+    /**
+     * 潛在的 步 (1~3, 0:停用)
+     */
+    potentialStep: string;
+    /**
+     * 潛在的 類型
+     */
+    potentialType: string | null;
+    /**
+     * 潛在的 增加 (對於攻擊力/魔法攻擊力以外的其他潛在能力類型，百分比)
+     */
+    potentialIncrease1: string | null;
+    /**
+     * 潛在的 增加 2 (如果潛在能力類型為攻擊力/魔法攻擊力，則攻擊力分配給 potential_increase_1，魔法攻擊力分配給 potential_increase_2；如果潛在能力類型為最大生命值/最大魔法值，則最大生命值分配給 potential_increase_1，最大魔法值分配給 potential_increase_2。)
+     */
+    potentialIncrease2: string | null;
+    constructor(obj: CharacterPetEquipmentPotentialBody);
+}

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

@@ -6,6 +6,7 @@ export * from './dto/character/characterBasic';
 export * from './dto/character/characterBeautyEquipment';
 export * from './dto/character/characterCashItemEquipment';
 export * from './dto/character/characterDojang';
+export * from './dto/character/characterFamiliar';
 export * from './dto/character/characterHexaMatrix';
 export * from './dto/character/characterHexaMatrixStat';
 export * from './dto/character/characterHyperStat';

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

@@ -5,6 +5,7 @@ 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 { CharacterFamiliarDto } from './dto/character/characterFamiliar';
 import { CharacterHexaMatrixDto } from './dto/character/characterHexaMatrix';
 import { CharacterHexaMatrixStatDto } from './dto/character/characterHexaMatrixStat';
 import { CharacterHyperStatDto } from './dto/character/characterHyperStat';
@@ -268,6 +269,17 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
      * @param dateOptions 要搜尋的日期 (TST)
      */
     getCharacterDojang(ocid: string, dateOptions?: DateOptions): Promise<CharacterDojangDto | null>;
+    /**
+     * 檢視萌獸資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    getCharacterFamiliar(ocid: string, dateOptions?: DateOptions): Promise<CharacterFamiliarDto | null>;
     /**
      * 檢視戰地等級與戰地階級資訊。
      * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。

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

@@ -0,0 +1,31 @@
+export type CharacterFamiliarBody = {
+    date: string | null;
+    familiar_link_slot: CharacterFamiliarLinkSlotBody[];
+    familiar_info: CharacterFamiliarInfoBody[];
+};
+export type CharacterFamiliarLinkSlotBody = {
+    slot_id: string | null;
+    familiar_name: string | null;
+    active_flag: string | null;
+    expire_date: string | null;
+};
+export type CharacterFamiliarInfoBody = {
+    familiar_name: string | null;
+    familiar_nickname: string | null;
+    familiar_special_flag: string | null;
+    familiar_state: string | null;
+    familiar_level: number;
+    familiar_exp: number;
+    skill_name: string | null;
+    option_level: number;
+    option: CharacterFamiliarInfoOptionBody[];
+    familiar_grade: string | null;
+    look_name: string | null;
+    summoned_flag: string | null;
+    slot_id: string | null;
+};
+export type CharacterFamiliarInfoOptionBody = {
+    option_no: number;
+    option_name: string | null;
+    option_value: string | null;
+};

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

@@ -11,6 +11,7 @@ export type CharacterPetEquipmentBody = {
     pet_1_date_expire: string | null;
     pet_1_appearance: string | null;
     pet_1_appearance_icon: string | null;
+    pet_1_potential: CharacterPetEquipmentPotentialBody[];
     pet_2_name: string | null;
     pet_2_nickname: string | null;
     pet_2_icon: string | null;
@@ -22,6 +23,7 @@ export type CharacterPetEquipmentBody = {
     pet_2_date_expire: string | null;
     pet_2_appearance: string | null;
     pet_2_appearance_icon: string | null;
+    pet_2_potential: CharacterPetEquipmentPotentialBody[];
     pet_3_name: string | null;
     pet_3_nickname: string | null;
     pet_3_icon: string | null;
@@ -33,6 +35,7 @@ export type CharacterPetEquipmentBody = {
     pet_3_date_expire: string | null;
     pet_3_appearance: string | null;
     pet_3_appearance_icon: string | null;
+    pet_3_potential: CharacterPetEquipmentPotentialBody[];
 };
 export type CharacterPetEquipmentItemBody = {
     item_name: string | null;
@@ -54,3 +57,9 @@ export type CharacterPetEquipmentAutoSkillBody = {
     skill_2: string | null;
     skill_2_icon: string | null;
 };
+export type CharacterPetEquipmentPotentialBody = {
+    potential_step: string;
+    potential_type: string | null;
+    potential_increase1: string | null;
+    potential_increase2: string | null;
+};