maplestory-openapi 3.3.0 → 3.4.0

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

@@ -0,0 +1,68 @@
+import * as base from '../../../common/dto/character/characterBasic';
+import { CharacterBasicBody } from '../../response/character/characterBasicBody';
+/**
+ * 角色基本資訊
+ */
+export declare class CharacterBasicDto extends base.CharacterBasicDto {
+    /**
+     * 要搜尋的日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    date: Date | null;
+    /**
+     * 角色名稱
+     */
+    characterName: string;
+    /**
+     * 世界名稱
+     */
+    worldName: string;
+    /**
+     * 角色性別
+     */
+    characterGender: string;
+    /**
+     * 角色職業
+     */
+    characterClass: string;
+    /**
+     * 角色轉職次數
+     */
+    characterClassLevel: string;
+    /**
+     * 角色等級
+     */
+    characterLevel: number;
+    /**
+     * 當前等級的經驗值
+     */
+    characterExp: number;
+    /**
+     * 當前等級的經驗值百分比
+     */
+    characterExpRate: string;
+    /**
+     * 角色所屬公會的名稱
+     */
+    characterGuildName: string | null;
+    /**
+     * 角色外型圖片
+     */
+    characterImage: string;
+    /**
+     * 角色建立日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    characterDateCreate: Date;
+    /**
+     * 過去 7 天的登入狀態 (true：已登入，false：未登入)
+     */
+    accessFlag: 'true' | 'false';
+    /**
+     * 解放任務完成狀態 (0：未完成，1：創世武器已解放)
+     */
+    liberationQuestClear: string;
+    constructor(obj: CharacterBasicBody);
+    /**
+     * Login status in the past 7 days
+     */
+    get isAccessFlag(): boolean;
+}

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

@@ -0,0 +1,117 @@
+import * as base from '../../../common/dto/character/characterBeautyEquipment';
+import { CharacterBeautyEquipmentBody, CharacterBeautyEquipmentFaceBody, CharacterBeautyEquipmentHairBody, CharacterBeautyEquipmentSkinBody } from '../../response/character/characterBeautyEquipmentBody';
+/**
+ * 角色目前已裝備的髮型、臉型與膚色資訊
+ */
+export declare class CharacterBeautyEquipmentDto extends base.CharacterBeautyEquipmentDto {
+    /**
+     * 要搜尋的日期 (TST)
+     */
+    date: Date | null;
+    /**
+     * 角色性別
+     */
+    characterGender: string;
+    /**
+     * 角色職業
+     */
+    characterClass: string;
+    /**
+     * 角色髮型資訊<br>
+     * (神之子為 Alpha、天使破壞者為一般模式時)
+     */
+    characterHair: CharacterBeautyEquipmentHairDto | null;
+    /**
+     * 角色臉型資訊<br>
+     * (神之子為 Alpha、天使破壞者為一般模式時)
+     */
+    characterFace: CharacterBeautyEquipmentFaceDto | null;
+    /**
+     * 角色膚色資訊<br>
+     * (神之子為 Alpha、天使破壞者為一般模式時)
+     */
+    characterSkin: CharacterBeautyEquipmentSkinDto | null;
+    /**
+     * 神之子為 Beta 及天使破壞者為變裝模式時的目前已裝備髮型資訊
+     */
+    additionalCharacterHair: CharacterBeautyEquipmentHairDto | null;
+    /**
+     * 神之子為 Beta 及天使破壞者為變裝模式時的目前已裝備臉型資訊
+     */
+    additionalCharacterFace: CharacterBeautyEquipmentFaceDto | null;
+    /**
+     * 神之子為 Beta 及天使破壞者為變裝模式時的目前已裝備膚色資訊
+     */
+    additionalCharacterSkin: CharacterBeautyEquipmentSkinDto | null;
+    constructor(obj: CharacterBeautyEquipmentBody);
+}
+/**
+ * 角色臉型資訊
+ */
+export declare class CharacterBeautyEquipmentFaceDto extends base.CharacterBeautyEquipmentFaceDto {
+    /**
+     * 臉型名稱
+     */
+    faceName: string;
+    /**
+     * 臉型基本顏色
+     */
+    baseColor: string;
+    /**
+     * 臉型混染顏色
+     */
+    mixColor: string | null;
+    /**
+     * 臉型混染顏色比例
+     */
+    mixRate: string;
+    constructor(obj: CharacterBeautyEquipmentFaceBody);
+}
+/**
+ * 角色髮型資訊
+ */
+export declare class CharacterBeautyEquipmentHairDto extends base.CharacterBeautyEquipmentHairDto {
+    /**
+     * 髮型名稱
+     */
+    hairName: string;
+    /**
+     * 髮型基本顏色
+     */
+    baseColor: string;
+    /**
+     * 髮型混染顏色
+     */
+    mixColor: string | null;
+    /**
+     * 髮型混染顏色比例
+     */
+    mixRate: string;
+    constructor(obj: CharacterBeautyEquipmentHairBody);
+}
+/**
+ * 角色膚色資訊
+ */
+export declare class CharacterBeautyEquipmentSkinDto extends base.CharacterBeautyEquipmentSkinDto {
+    /**
+     * 膚色名稱
+     */
+    skinName: string;
+    /**
+     * 色系
+     */
+    colorStyle: string | null;
+    /**
+     * 膚色色調
+     */
+    hue: number | null;
+    /**
+     * 膚色彩度
+     */
+    saturation: number | null;
+    /**
+     * 膚色明度
+     */
+    brightness: number | null;
+    constructor(obj: CharacterBeautyEquipmentSkinBody);
+}

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

@@ -0,0 +1,158 @@
+import * as base from '../../../common/dto/character/characterCashItemEquipment';
+import { CharacterCashItemEquipmentBody, CharacterCashItemEquipmentColoringPrismBody, CharacterCashItemEquipmentOptionBody, CharacterCashItemEquipmentPresetBody } from '../../response/character/characterCashItemEquipmentBody';
+/**
+ * 角色已裝備現金道具資訊
+ */
+export declare class CharacterCashItemEquipmentDto extends base.CharacterCashItemEquipmentDto {
+    /**
+     * 要搜尋的日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    date: Date | null;
+    /**
+     * 角色性別
+     */
+    characterGender: string | null;
+    /**
+     * 角色職業
+     */
+    characterClass: string | null;
+    /**
+     * 角色外型模式 (0：一般模式，1：神之子為 Beta、天使破壞者為變裝模式時)
+     */
+    characterLookMode: string | null;
+    /**
+     * 目前套用的現金道具預設編號
+     */
+    presetNo: number | null;
+    /**
+     * 目前已裝備的現金道具
+     */
+    cashItemEquipmentBase: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * 外型預設 1
+     */
+    cashItemEquipmentPreset1: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * 外型預設 2
+     */
+    cashItemEquipmentPreset2: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * 外型預設 3
+     */
+    cashItemEquipmentPreset3: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * 神之子為 Beta 及天使破壞者為變裝模式時的目前已裝備現金道具
+     */
+    additionalCashItemEquipmentBase: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * 神之子為 Beta 及天使破壞者為變裝模式時的外型預設 1
+     */
+    additionalCashItemEquipmentPreset1: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * 神之子為 Beta 及天使破壞者為變裝模式時的外型預設 2
+     */
+    additionalCashItemEquipmentPreset2: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * 神之子為 Beta 及天使破壞者為變裝模式時的外型預設 3
+     */
+    additionalCashItemEquipmentPreset3: CharacterCashItemEquipmentPresetDto[];
+    constructor(obj: CharacterCashItemEquipmentBody);
+}
+/**
+ * 現金道具彩色稜鏡資訊
+ */
+export declare class CharacterCashItemEquipmentColoringPrismDto extends base.CharacterCashItemEquipmentColoringPrismDto {
+    /**
+     * 彩色稜鏡顏色範圍
+     */
+    colorRange: string;
+    /**
+     * 彩色稜鏡色調
+     */
+    hue: number;
+    /**
+     * 彩色稜鏡彩度
+     */
+    saturation: number;
+    /**
+     * 彩色稜鏡明度
+     */
+    value: number;
+    constructor(obj: CharacterCashItemEquipmentColoringPrismBody);
+}
+/**
+ * 現金道具選項
+ */
+export declare class CharacterCashItemEquipmentOptionDto extends base.CharacterCashItemEquipmentOptionDto {
+    /**
+     * 選項類型
+     */
+    optionType: string;
+    /**
+     * 選項數值
+     */
+    optionValue: string;
+    constructor(obj: CharacterCashItemEquipmentOptionBody);
+}
+/**
+ * 外型預設
+ */
+export declare class CharacterCashItemEquipmentPresetDto extends base.CharacterCashItemEquipmentPresetDto {
+    /**
+     * 現金道具部位名稱
+     */
+    cashItemEquipmentPart: string;
+    /**
+     * 現金道具欄位位置
+     */
+    cashItemEquipmentSlot: string;
+    /**
+     * 現金道具名稱
+     */
+    cashItemName: string;
+    /**
+     * 現金道具圖示
+     */
+    cashItemIcon: string;
+    /**
+     * 現金道具描述
+     */
+    cashItemDescription: string | null;
+    /**
+     * 現金道具選項
+     */
+    cashItemOption: CharacterCashItemEquipmentOptionDto[];
+    /**
+     * 現金道具有效期間 (TST)
+     */
+    dateExpire: Date | null;
+    /**
+     * Whether the cash equipment is expired
+     */
+    isExpired: boolean | null;
+    /**
+     * 現金道具選項有效期間 (TST，時間單位資料中的分鐘顯示為 0)
+     */
+    dateOptionExpire: Date | null;
+    /**
+     * Whether the cash equipment option is expired
+     */
+    isOptionExpired: boolean | null;
+    /**
+     * 現金道具等級資訊
+     */
+    cashItemLabel: string | null;
+    /**
+     * 現金道具彩色稜鏡資訊
+     */
+    cashItemColoringPrism: CharacterCashItemEquipmentColoringPrismDto | null;
+    /**
+     * 道具可裝備性別
+     */
+    itemGender: string | null;
+    /**
+     * 技能名稱
+     */
+    skills: string[];
+    constructor(obj: CharacterCashItemEquipmentPresetBody);
+}

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

@@ -0,0 +1,32 @@
+import * as base from '../../../common/dto/character/characterDojang';
+import { CharacterDojangBody } from '../../response/character/characterDojangBody';
+/**
+ * 角色在武陵道場的最高紀錄資訊
+ */
+export declare class CharacterDojangDto extends base.CharacterDojangDto {
+    /**
+     * 要搜尋的日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    date: Date | null;
+    /**
+     * 角色職業
+     */
+    characterClass: string | null;
+    /**
+     * 世界名稱
+     */
+    worldName: string | null;
+    /**
+     * 武陵道場最高紀錄層數
+     */
+    dojangBestFloor: number | null;
+    /**
+     * 達成武陵道場最高紀錄的日期 (TST，每日資料的小時與分鐘顯示為 0)
+     */
+    dateDojangRecord: Date | null;
+    /**
+     * 通關武陵道場最高樓層所花費的時間 (秒)
+     */
+    dojangBestTime: number | null;
+    constructor(obj: CharacterDojangBody);
+}

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

@@ -0,0 +1,48 @@
+import * as base from '../../../common/dto/character/characterHexaMatrix';
+import { CharacterHexaMatrixBody, CharacterHexaMatrixEquipmentBody, CharacterHexaMatrixEquipmentLinkedSkillBody } from '../../response/character/characterHexaMatrixBody';
+/**
+ * 角色已裝備於 HEXA 矩陣的 HEXA 核心資訊
+ */
+export declare class CharacterHexaMatrixDto extends base.CharacterHexaMatrixDto {
+    /**
+     * 要搜尋的日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    date: Date | null;
+    /**
+     * HEXA 核心資訊
+     */
+    characterHexaCoreEquipment: CharacterHexaMatrixEquipmentDto[];
+    constructor(obj: CharacterHexaMatrixBody);
+}
+/**
+ * 已連接的技能
+ */
+export declare class CharacterHexaMatrixEquipmentLinkedSkillDto extends base.CharacterHexaMatrixEquipmentLinkedSkillDto {
+    /**
+     * HEXA 技能名稱
+     */
+    hexaSkillId: string;
+    constructor(obj: CharacterHexaMatrixEquipmentLinkedSkillBody);
+}
+/**
+ * HEXA 核心資訊
+ */
+export declare class CharacterHexaMatrixEquipmentDto extends base.CharacterHexaMatrixEquipmentDto {
+    /**
+     * 核心名稱
+     */
+    hexaCoreName: string;
+    /**
+     * 核心等級
+     */
+    hexaCoreLevel: number;
+    /**
+     * 核心類型
+     */
+    hexaCoreType: string;
+    /**
+     * 已連接的技能
+     */
+    linkedSkill: CharacterHexaMatrixEquipmentLinkedSkillDto[];
+    constructor(obj: CharacterHexaMatrixEquipmentBody);
+}

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

@@ -0,0 +1,78 @@
+import * as base from '../../../common/dto/character/characterHexaMatrixStat';
+import { CharacterHexaMatrixStatBody, CharacterHexaMatrixStatCoreBody } from '../../response/character/characterHexaMatrixStatBody';
+/**
+ * 角色設定於 HEXA 矩陣中的 HEXA 屬性資訊
+ */
+export declare class CharacterHexaMatrixStatDto extends base.CharacterHexaMatrixStatDto {
+    /**
+     * 要搜尋的日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    date: Date | null;
+    /**
+     * 角色職業
+     */
+    characterClass: string | null;
+    /**
+     * HEXA 屬性 I 核心資訊
+     */
+    characterHexaStatCore: CharacterHexaMatrixStatCoreDto[];
+    /**
+     * HEXA 屬性 II 核心資訊
+     */
+    characterHexaStatCore2: CharacterHexaMatrixStatCoreDto[];
+    /**
+     * HEXA 屬性 III 核心資訊
+     */
+    characterHexaStatCore3: CharacterHexaMatrixStatCoreDto[];
+    /**
+     * 預設的 HEXA 屬性 I 核心資訊
+     */
+    presetHexaStatCore: CharacterHexaMatrixStatCoreDto[];
+    /**
+     * 預設的 HEXA 屬性 II 核心資訊
+     */
+    presetHexaStatCore2: CharacterHexaMatrixStatCoreDto[];
+    /**
+     * 預設的 HEXA 屬性 III 核心資訊
+     */
+    presetHexaStatCore3: CharacterHexaMatrixStatCoreDto[];
+    constructor(obj: CharacterHexaMatrixStatBody);
+}
+/**
+ * HEXA 屬性核心資訊
+ */
+export declare class CharacterHexaMatrixStatCoreDto extends base.CharacterHexaMatrixStatCoreDto {
+    /**
+     * 欄位索引
+     */
+    slotId: string;
+    /**
+     * 主要屬性名稱
+     */
+    mainStatName: string;
+    /**
+     * 第一副屬性名稱
+     */
+    subStatName1: string;
+    /**
+     * 第二副屬性名稱
+     */
+    subStatName2: string;
+    /**
+     * 主要屬性等級
+     */
+    mainStatLevel: number;
+    /**
+     * 第一副屬性等級
+     */
+    subStatLevel1: number;
+    /**
+     * 第二副屬性等級
+     */
+    subStatLevel2: number;
+    /**
+     * 屬性核心階級
+     */
+    statGrade: number;
+    constructor(obj: CharacterHexaMatrixStatCoreBody);
+}

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

@@ -0,0 +1,70 @@
+import * as base from '../../../common/dto/character/characterHyperStat';
+import { CharacterHyperStatBody, CharacterHyperStatPresetBody } from '../../response/character/characterHyperStatBody';
+/**
+ * 角色極限屬性資訊
+ */
+export declare class CharacterHyperStatDto extends base.CharacterHyperStatDto {
+    /**
+     * 要搜尋的日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    date: Date | null;
+    /**
+     * 角色職業
+     */
+    characterClass: string | null;
+    /**
+     * 目前套用的預設編號
+     */
+    usePresetNo: string | null;
+    /**
+     * 可用的極限屬性點數上限
+     */
+    useAvailableHyperStat: number | null;
+    /**
+     * 預設 1 的極限屬性資訊
+     */
+    hyperStatPreset1: CharacterHyperStatPresetDto[];
+    /**
+     * 預設 1 剩餘的極限屬性點數
+     */
+    hyperStatPreset1RemainPoint: number | null;
+    /**
+     * 預設 2 的極限屬性資訊
+     */
+    hyperStatPreset2: CharacterHyperStatPresetDto[];
+    /**
+     * 預設 2 剩餘的極限屬性點數
+     */
+    hyperStatPreset2RemainPoint: number | null;
+    /**
+     * 預設 3 的極限屬性資訊
+     */
+    hyperStatPreset3: CharacterHyperStatPresetDto[];
+    /**
+     * 預設 3 剩餘的極限屬性點數
+     */
+    hyperStatPreset3RemainPoint: number | null;
+    constructor(obj: CharacterHyperStatBody);
+}
+/**
+ * 預設的極限屬性資訊
+ */
+export declare class CharacterHyperStatPresetDto extends base.CharacterHyperStatPresetDto {
+    /**
+     * 能力值類型
+     */
+    statType: string;
+    /**
+     * 投入於能力值的點數
+     */
+    statPoint: number | null;
+    /**
+     * 能力值等級
+     */
+    statLevel: number;
+    /**
+     * 能力值提升量
+     */
+    statIncrease: string | null;
+    constructor(obj: CharacterHyperStatPresetBody);
+}

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

@@ -0,0 +1,74 @@
+import * as base from '../../../common/dto/character/characterImage';
+import { CharacterImageAction, CharacterImageEmotion, CharacterImageWeaponMotion } from '../../../common/enum/characterImage';
+/**
+ * 角色外型圖片資訊
+ */
+export declare class CharacterImageDto extends base.CharacterImageDto {
+    /**
+     * 要搜尋的日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    date: Date | null;
+    /**
+     * 角色外型圖片原始 (URL)
+     */
+    originUrl: string;
+    /**
+     * 角色外型圖片原始 (base64)
+     */
+    originImage: string;
+    /**
+     * 角色外型圖片 (base64)
+     */
+    image: string;
+    /**
+     * 角色動作
+     */
+    action: CharacterImageAction;
+    /**
+     * 角色表情
+     */
+    emotion: CharacterImageEmotion;
+    /**
+     * 角色武器動作
+     */
+    wmotion: CharacterImageWeaponMotion;
+    /**
+     * 角色動作影格
+     */
+    actionFrame: number | null;
+    /**
+     * 角色表情影格
+     */
+    emotionFrame: number | null;
+    /**
+     * 寬度 (對應背景大小，96 (預設) 至 1000)
+     */
+    width: number;
+    /**
+     * 高度 (對應背景大小，96 (預設) 至 1000)
+     */
+    height: number;
+    /**
+     * 角色的水平座標 (座標範圍 0 < x < 寬度，0 對應至最左起點)
+     */
+    x: number | null;
+    /**
+     * 角色的垂直座標 (座標範圍 0 < y < 高度，0 對應至最上方起點)
+     */
+    y: number | null;
+    constructor(obj: {
+        date: Date | null;
+        originUrl: string;
+        originImage: string;
+        image: string;
+        action: CharacterImageAction;
+        emotion: CharacterImageEmotion;
+        wmotion: CharacterImageWeaponMotion;
+        actionFrame: number | null;
+        emotionFrame: number | null;
+        width: number;
+        height: number;
+        x: number | null;
+        y: number | null;
+    });
+}