maplestory-openapi 3.2.1 → 3.4.0

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

@@ -0,0 +1,299 @@
+import * as base from '../../../common/dto/character/characterAndroidEquipment';
+import { CharacterAndroidCashItemEquipmentBody, CharacterAndroidCashItemEquipmentColoringPrismBody, CharacterAndroidCashItemEquipmentOptionBody, CharacterAndroidEquipmentBody, CharacterAndroidEquipmentFaceBody, CharacterAndroidEquipmentHairBody, CharacterAndroidEquipmentPresetBody, CharacterAndroidEquipmentSkinBody } from '../../response/character/characterAndroidEquipmentBody';
+/**
+ * 角色已裝備機器人資訊
+ */
+export declare class CharacterAndroidEquipmentDto extends base.CharacterAndroidEquipmentDto {
+    /**
+     * 要搜尋的日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    date: Date | null;
+    /**
+     * 機器人名稱
+     */
+    androidName: string | null;
+    /**
+     * 機器人暱稱
+     */
+    androidNickname: string | null;
+    /**
+     * 機器人圖示
+     */
+    androidIcon: string | null;
+    /**
+     * 機器人道具描述
+     */
+    androidDescription: string | null;
+    /**
+     * 機器人髮型資訊
+     */
+    androidHair: CharacterAndroidEquipmentHairDto | null;
+    /**
+     * 機器人臉型資訊
+     */
+    androidFace: CharacterAndroidEquipmentFaceDto | null;
+    /**
+     * 機器人膚色資訊
+     */
+    androidSkin: CharacterAndroidEquipmentSkinDto | null;
+    /**
+     * 機器人的已裝備現金道具資訊
+     */
+    androidCashItemEquipment: CharacterAndroidCashItemEquipmentDto[];
+    /**
+     * 機器人耳飾感應器
+     */
+    androidEarSensorClipFlag: string | null;
+    /**
+     * 機器人性別
+     */
+    androidGender: string | null;
+    /**
+     * 機器人階級
+     */
+    androidGrade: string | null;
+    /**
+     * 非人型機器人
+     */
+    androidNonHumanoidFlag: string | null;
+    /**
+     * 是否具備雜貨店功能
+     */
+    androidShopUsableFlag: string | null;
+    /**
+     * 目前套用的道具預設編號
+     */
+    presetNo: number | null;
+    /**
+     * 預設 1 的機器人資訊
+     */
+    androidPreset1: CharacterAndroidEquipmentPresetDto | null;
+    /**
+     * 預設 2 的機器人資訊
+     */
+    androidPreset2: CharacterAndroidEquipmentPresetDto | null;
+    /**
+     * 預設 3 的機器人資訊
+     */
+    androidPreset3: CharacterAndroidEquipmentPresetDto | null;
+    constructor(obj: CharacterAndroidEquipmentBody);
+}
+/**
+ * 機器人臉型資訊
+ */
+export declare class CharacterAndroidEquipmentFaceDto extends base.CharacterAndroidEquipmentFaceDto {
+    /**
+     * 機器人臉型名稱
+     */
+    faceName: string | null;
+    /**
+     * 機器人臉型基本顏色
+     */
+    baseColor: string | null;
+    /**
+     * 機器人臉型混染顏色
+     */
+    mixColor: string | null;
+    /**
+     * 機器人臉型混染顏色比例
+     */
+    mixRate: string;
+    constructor(obj: CharacterAndroidEquipmentFaceBody);
+}
+/**
+ * 機器人髮型資訊
+ */
+export declare class CharacterAndroidEquipmentHairDto extends base.CharacterAndroidEquipmentHairDto {
+    /**
+     * 機器人髮型名稱
+     */
+    hairName: string | null;
+    /**
+     * 機器人髮型基本顏色
+     */
+    baseColor: string | null;
+    /**
+     * 機器人髮型混染顏色
+     */
+    mixColor: string | null;
+    /**
+     * 機器人髮型混染顏色比例
+     */
+    mixRate: string;
+    constructor(obj: CharacterAndroidEquipmentHairBody);
+}
+/**
+ * 機器人膚色資訊
+ */
+export declare class CharacterAndroidEquipmentSkinDto extends base.CharacterAndroidEquipmentSkinDto {
+    /**
+     * 膚色名稱
+     */
+    skinName: string;
+    /**
+     * 色系
+     */
+    colorStyle: string | null;
+    /**
+     * 膚色色調
+     */
+    hue: number | null;
+    /**
+     * 膚色彩度
+     */
+    saturation: number | null;
+    /**
+     * 膚色明度
+     */
+    brightness: number | null;
+    constructor(obj: CharacterAndroidEquipmentSkinBody);
+}
+/**
+ * 預設的機器人資訊
+ */
+export declare class CharacterAndroidEquipmentPresetDto extends base.CharacterAndroidEquipmentPresetDto {
+    /**
+     * 機器人名稱
+     */
+    androidName: string;
+    /**
+     * 機器人暱稱
+     */
+    androidNickname: string;
+    /**
+     * 機器人圖示
+     */
+    androidIcon: string;
+    /**
+     * 機器人道具描述
+     */
+    androidDescription: string;
+    /**
+     * 機器人性別
+     */
+    androidGender: string | null;
+    /**
+     * 機器人階級
+     */
+    androidGrade: string;
+    /**
+     *
+     * 機器人髮型資訊
+     */
+    androidHair: CharacterAndroidEquipmentHairDto;
+    /**
+     * 機器人臉型資訊
+     */
+    androidFace: CharacterAndroidEquipmentFaceDto;
+    /**
+     * 機器人膚色資訊
+     */
+    androidSkin: CharacterAndroidEquipmentSkinDto | null;
+    /**
+     * 機器人耳飾感應器
+     */
+    androidEarSensorClipFlag: string;
+    /**
+     * 非人型機器人
+     */
+    androidNonHumanoidFlag: string;
+    /**
+     * 是否具備雜貨店功能
+     */
+    androidShopUsableFlag: string;
+    constructor(obj: CharacterAndroidEquipmentPresetBody);
+}
+/**
+ * 機器人現金道具彩色稜鏡資訊
+ */
+export declare class CharacterAndroidCashItemEquipmentColoringPrismDto extends base.CharacterAndroidCashItemEquipmentColoringPrismDto {
+    /**
+     * 彩色稜鏡顏色範圍
+     */
+    colorRange: string;
+    /**
+     * 彩色稜鏡色調
+     */
+    hue: number;
+    /**
+     * 彩色稜鏡彩度
+     */
+    saturation: number;
+    /**
+     * 彩色稜鏡明度
+     */
+    value: number;
+    constructor(obj: CharacterAndroidCashItemEquipmentColoringPrismBody);
+}
+/**
+ * 機器人現金道具選項
+ */
+export declare class CharacterAndroidCashItemEquipmentOptionDto extends base.CharacterAndroidCashItemEquipmentOptionDto {
+    /**
+     * 選項類型
+     */
+    optionType: string;
+    /**
+     * 選項數值
+     */
+    optionValue: string;
+    constructor(obj: CharacterAndroidCashItemEquipmentOptionBody);
+}
+/**
+ * 機器人的已裝備現金道具資訊
+ */
+export declare class CharacterAndroidCashItemEquipmentDto extends base.CharacterAndroidCashItemEquipmentDto {
+    /**
+     * 機器人現金道具部位名稱
+     */
+    cashItemEquipmentPart: string;
+    /**
+     * 機器人現金道具欄位位置
+     */
+    cashItemEquipmentSlot: string;
+    /**
+     * 機器人現金道具名稱
+     */
+    cashItemName: string;
+    /**
+     * 機器人現金道具圖示
+     */
+    cashItemIcon: string;
+    /**
+     * 機器人現金道具描述
+     */
+    cashItemDescription: string | null;
+    /**
+     * 機器人現金道具選項
+     */
+    cashItemOption: CharacterAndroidCashItemEquipmentOptionDto[];
+    /**
+     * 機器人現金道具有效期間 (TST)
+     */
+    dateExpire: Date | null;
+    /**
+     * Whether the android cash item is expired
+     */
+    isExpired: boolean | null;
+    /**
+     * 機器人現金道具選項有效期間 (TST，時間單位資料中的分鐘顯示為 0)
+     */
+    dateOptionExpire: Date | null;
+    /**
+     * Whether the android cash item option is expired
+     */
+    isOptionExpired: boolean | null;
+    /**
+     * 機器人現金道具標籤資訊 (特殊標籤、紅標籤、黑標籤、大師標籤)
+     */
+    cashItemLabel: string | null;
+    /**
+     * 機器人現金道具彩色稜鏡資訊
+     */
+    cashItemColoringPrism: CharacterAndroidCashItemEquipmentColoringPrismDto | null;
+    /**
+     * 道具可裝備性別
+     */
+    androidItemGender: string | null;
+    constructor(obj: CharacterAndroidCashItemEquipmentBody);
+}

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);
+}