maplestory-openapi 2.13.1 → 3.1.0

package/types/maplestory/api/msea/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';
+/**
+ * Character android equipment information
+ */
+export declare class CharacterAndroidEquipmentDto extends base.CharacterAndroidEquipmentDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Android name
+     */
+    androidName: string | null;
+    /**
+     * Android nickname
+     */
+    androidNickname: string | null;
+    /**
+     * Android icon
+     */
+    androidIcon: string | null;
+    /**
+     * Android item description
+     */
+    androidDescription: string | null;
+    /**
+     * Android hair information
+     */
+    androidHair: CharacterAndroidEquipmentHairDto | null;
+    /**
+     * Android face information
+     */
+    androidFace: CharacterAndroidEquipmentFaceDto | null;
+    /**
+     * Android skin information
+     */
+    androidSkin: CharacterAndroidEquipmentSkinDto | null;
+    /**
+     * Android cash item equipment information
+     */
+    androidCashItemEquipment: CharacterAndroidCashItemEquipmentDto[];
+    /**
+     * Whether the Android ear sensor clip is applied
+     */
+    androidEarSensorClipFlag: string | null;
+    /**
+     * Android gender
+     */
+    androidGender: string | null;
+    /**
+     * Android grade
+     */
+    androidGrade: string | null;
+    /**
+     * Whether the Android is non-humanoid
+     */
+    androidNonHumanoidFlag: string | null;
+    /**
+     * Whether the Android can use the general store functionality
+     */
+    androidShopUsableFlag: string | null;
+    /**
+     * Active equipment preset number
+     */
+    presetNo: number | null;
+    /**
+     * Android information for preset 1
+     */
+    androidPreset1: CharacterAndroidEquipmentPresetDto | null;
+    /**
+     * Android information for preset 2
+     */
+    androidPreset2: CharacterAndroidEquipmentPresetDto | null;
+    /**
+     * Android information for preset 3
+     */
+    androidPreset3: CharacterAndroidEquipmentPresetDto | null;
+    constructor(obj: CharacterAndroidEquipmentBody);
+}
+/**
+ * Android face information
+ */
+export declare class CharacterAndroidEquipmentFaceDto extends base.CharacterAndroidEquipmentFaceDto {
+    /**
+     * Android face name
+     */
+    faceName: string | null;
+    /**
+     * Android base face color
+     */
+    baseColor: string | null;
+    /**
+     * Android mixed face color
+     */
+    mixColor: string | null;
+    /**
+     * Dye ratio for Android mixed face color
+     */
+    mixRate: string;
+    constructor(obj: CharacterAndroidEquipmentFaceBody);
+}
+/**
+ * Android hair information
+ */
+export declare class CharacterAndroidEquipmentHairDto extends base.CharacterAndroidEquipmentHairDto {
+    /**
+     * Android hair name
+     */
+    hairName: string | null;
+    /**
+     * Android base hair color
+     */
+    baseColor: string | null;
+    /**
+     * Android mixed hair color
+     */
+    mixColor: string | null;
+    /**
+     * Dye ratio for Android mixed hair color
+     */
+    mixRate: string;
+    constructor(obj: CharacterAndroidEquipmentHairBody);
+}
+/**
+ * Android skin information
+ */
+export declare class CharacterAndroidEquipmentSkinDto extends base.CharacterAndroidEquipmentSkinDto {
+    /**
+     * Skin name
+     */
+    skinName: string;
+    /**
+     * Color style
+     */
+    colorStyle: string | null;
+    /**
+     * Skin hue
+     */
+    hue: number | null;
+    /**
+     * Skin saturation
+     */
+    saturation: number | null;
+    /**
+     * Skin brightness
+     */
+    brightness: number | null;
+    constructor(obj: CharacterAndroidEquipmentSkinBody);
+}
+/**
+ * Android preset information
+ */
+export declare class CharacterAndroidEquipmentPresetDto extends base.CharacterAndroidEquipmentPresetDto {
+    /**
+     * Android name
+     */
+    androidName: string;
+    /**
+     * Android nickname
+     */
+    androidNickname: string;
+    /**
+     * Android icon
+     */
+    androidIcon: string;
+    /**
+     * Android item description
+     */
+    androidDescription: string;
+    /**
+     * Android gender
+     */
+    androidGender: string | null;
+    /**
+     * Android grade
+     */
+    androidGrade: string;
+    /**
+     *
+     * Android hair information
+     */
+    androidHair: CharacterAndroidEquipmentHairDto;
+    /**
+     * Android face information
+     */
+    androidFace: CharacterAndroidEquipmentFaceDto;
+    /**
+     * Android skin information
+     */
+    androidSkin: CharacterAndroidEquipmentSkinDto | null;
+    /**
+     * Whether the Android ear sensor clip is applied
+     */
+    androidEarSensorClipFlag: string;
+    /**
+     * Whether the Android is non-humanoid
+     */
+    androidNonHumanoidFlag: string;
+    /**
+     * Whether the Android can use the general store functionality
+     */
+    androidShopUsableFlag: string;
+    constructor(obj: CharacterAndroidEquipmentPresetBody);
+}
+/**
+ * Android cash item coloring prism information
+ */
+export declare class CharacterAndroidCashItemEquipmentColoringPrismDto extends base.CharacterAndroidCashItemEquipmentColoringPrismDto {
+    /**
+     * Coloring prism color range
+     */
+    colorRange: string;
+    /**
+     * Coloring prism hue
+     */
+    hue: number;
+    /**
+     * Coloring prism saturation
+     */
+    saturation: number;
+    /**
+     * Coloring prism brightness
+     */
+    value: number;
+    constructor(obj: CharacterAndroidCashItemEquipmentColoringPrismBody);
+}
+/**
+ * Android cash item options
+ */
+export declare class CharacterAndroidCashItemEquipmentOptionDto extends base.CharacterAndroidCashItemEquipmentOptionDto {
+    /**
+     * Option type
+     */
+    optionType: string;
+    /**
+     * Option value
+     */
+    optionValue: string;
+    constructor(obj: CharacterAndroidCashItemEquipmentOptionBody);
+}
+/**
+ * Android cash item equipment information
+ */
+export declare class CharacterAndroidCashItemEquipmentDto extends base.CharacterAndroidCashItemEquipmentDto {
+    /**
+     * Android cash item part name
+     */
+    cashItemEquipmentPart: string;
+    /**
+     * Android cash item slot position
+     */
+    cashItemEquipmentSlot: string;
+    /**
+     * Android cash item name
+     */
+    cashItemName: string;
+    /**
+     * Android cash item icon
+     */
+    cashItemIcon: string;
+    /**
+     * Android cash item description
+     */
+    cashItemDescription: string | null;
+    /**
+     * Android cash item options
+     */
+    cashItemOption: CharacterAndroidCashItemEquipmentOptionDto[];
+    /**
+     * Android cash item validity period (SGT)
+     */
+    dateExpire: Date | null;
+    /**
+     * Whether the android cash item is expired
+     */
+    isExpired: boolean | null;
+    /**
+     * Android cash item option validity period (SGT, data with minutes set to 0)
+     */
+    dateOptionExpire: Date | null;
+    /**
+     * Whether the android cash item option is expired
+     */
+    isOptionExpired: boolean | null;
+    /**
+     * Android cash item label information (e.g., Special Label, Red Label, Black Label, Master Label)
+     */
+    cashItemLabel: string | null;
+    /**
+     * Android cash item coloring prism information
+     */
+    cashItemColoringPrism: CharacterAndroidCashItemEquipmentColoringPrismDto | null;
+    /**
+     * Gender compatibility for item equipment
+     */
+    androidItemGender: string | null;
+    constructor(obj: CharacterAndroidCashItemEquipmentBody);
+}

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

@@ -0,0 +1,72 @@
+import * as base from '../../../common/dto/character/characterBasic';
+import { CharacterBasicBody } from '../../response/character/characterBasicBody';
+/**
+ * Character basic information
+ */
+export declare class CharacterBasicDto extends base.CharacterBasicDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Character name
+     */
+    characterName: string;
+    /**
+     * Character gender
+     */
+    worldName: string;
+    /**
+     * Character gender
+     */
+    characterGender: string;
+    /**
+     * Character job
+     */
+    characterClass: string;
+    /**
+     * Character job advancement tier
+     */
+    characterClassLevel: string;
+    /**
+     * Character level
+     */
+    characterLevel: number;
+    /**
+     * Experience points gained at the current level
+     */
+    characterExp: number;
+    /**
+     * Percentage of experience points at the current level
+     */
+    characterExpRate: string;
+    /**
+     * Guild name the character belongs to
+     */
+    characterGuildName: string | null;
+    /**
+     * Character appearance image
+     */
+    characterImage: string;
+    /**
+     * Character creation date (SGT, daily data with hours and minutes set to 0)
+     */
+    characterDateCreate: Date;
+    /**
+     * Login status in the past 7 days (true:logged in, false:not logged in)
+     */
+    accessFlag: 'true' | 'false';
+    /**
+     * Liberation quest completion status (true:completed, false:not completed)
+     */
+    liberationQuestClearFlag: 'true' | 'false';
+    constructor(obj: CharacterBasicBody);
+    /**
+     * Login status in the past 7 days
+     */
+    get isAccessFlag(): boolean;
+    /**
+     * Liberation quest completion status
+     */
+    get isLiberationQuestClearFlag(): boolean;
+}

package/types/maplestory/api/msea/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';
+/**
+ * Character equipped hair, face, and skin information
+ */
+export declare class CharacterBeautyEquipmentDto extends base.CharacterBeautyEquipmentDto {
+    /**
+     * Reference date for query (SGT)
+     */
+    date: Date | null;
+    /**
+     * Character gender
+     */
+    characterGender: string;
+    /**
+     * Character job
+     */
+    characterClass: string;
+    /**
+     * Character hair information<br>
+     * (Alpha mode for Zero, Normal mode for Angelic Buster)
+     */
+    characterHair: CharacterBeautyEquipmentHairDto | null;
+    /**
+     * Character face information<br>
+     * (Alpha mode for Zero, Normal mode for Angelic Buster)
+     */
+    characterFace: CharacterBeautyEquipmentFaceDto | null;
+    /**
+     * Character skin information<br>
+     * (Alpha mode for Zero, Normal mode for Angelic Buster)
+     */
+    characterSkin: CharacterBeautyEquipmentSkinDto | null;
+    /**
+     * Hair information applied in Beta mode for Zero or Dress-up mode for Angelic Buster
+     */
+    additionalCharacterHair: CharacterBeautyEquipmentHairDto | null;
+    /**
+     * Face information applied in Beta mode for Zero or Dress-up mode for Angelic Buster
+     */
+    additionalCharacterFace: CharacterBeautyEquipmentFaceDto | null;
+    /**
+     * Skin information applied in Beta mode for Zero or Dress-up mode for Angelic Buster
+     */
+    additionalCharacterSkin: CharacterBeautyEquipmentSkinDto | null;
+    constructor(obj: CharacterBeautyEquipmentBody);
+}
+/**
+ * Character face information
+ */
+export declare class CharacterBeautyEquipmentFaceDto extends base.CharacterBeautyEquipmentFaceDto {
+    /**
+     * Face name
+     */
+    faceName: string;
+    /**
+     * Base face color
+     */
+    baseColor: string;
+    /**
+     * Mixed face color
+     */
+    mixColor: string | null;
+    /**
+     * Dye ratio for mixed face color
+     */
+    mixRate: string;
+    constructor(obj: CharacterBeautyEquipmentFaceBody);
+}
+/**
+ * Character hair information
+ */
+export declare class CharacterBeautyEquipmentHairDto extends base.CharacterBeautyEquipmentHairDto {
+    /**
+     * Hair name
+     */
+    hairName: string;
+    /**
+     * Base hair color
+     */
+    baseColor: string;
+    /**
+     * Mixed hair color
+     */
+    mixColor: string | null;
+    /**
+     * Dye ratio for mixed hair color
+     */
+    mixRate: string;
+    constructor(obj: CharacterBeautyEquipmentHairBody);
+}
+/**
+ * Character skin information
+ */
+export declare class CharacterBeautyEquipmentSkinDto extends base.CharacterBeautyEquipmentSkinDto {
+    /**
+     * Skin name
+     */
+    skinName: string;
+    /**
+     * Color style
+     */
+    colorStyle: string | null;
+    /**
+     * Skin hue
+     */
+    hue: number | null;
+    /**
+     * Skin saturation
+     */
+    saturation: number | null;
+    /**
+     * Skin brightness
+     */
+    brightness: number | null;
+    constructor(obj: CharacterBeautyEquipmentSkinBody);
+}

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

@@ -0,0 +1,154 @@
+import * as base from '../../../common/dto/character/characterCashItemEquipment';
+import { CharacterCashItemEquipmentBody, CharacterCashItemEquipmentColoringPrismBody, CharacterCashItemEquipmentOptionBody, CharacterCashItemEquipmentPresetBody } from '../../response/character/characterCashItemEquipmentBody';
+/**
+ * Character cash item equipment information
+ */
+export declare class CharacterCashItemEquipmentDto extends base.CharacterCashItemEquipmentDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Character gender
+     */
+    characterGender: string | null;
+    /**
+     * Character job
+     */
+    characterClass: string | null;
+    /**
+     * Character appearance mode (0:Normal mode, 1:Beta for Zero, Dress-up mode for Angelic Buster)
+     */
+    characterLookMode: string | null;
+    /**
+     * Preset number for equipped cash item
+     */
+    presetNo: number | null;
+    /**
+     * Equipped cash item
+     */
+    cashItemEquipmentBase: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * Cosmetic item preset 1
+     */
+    cashItemEquipmentPreset1: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * Cosmetic item preset 2
+     */
+    cashItemEquipmentPreset2: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * Cosmetic item preset 3
+     */
+    cashItemEquipmentPreset3: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * Equipped cash items for Beta mode (if Zero) or Dress-up mode (if Angelic Buster)
+     */
+    additionalCashItemEquipmentBase: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * Cosmetic item preset 1 for Beta mode (if Zero) or Dress-up mode (if Angelic Buster)
+     */
+    additionalCashItemEquipmentPreset1: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * Cosmetic item preset 2 for Beta mode (if Zero) or Dress-up mode (if Angelic Buster)
+     */
+    additionalCashItemEquipmentPreset2: CharacterCashItemEquipmentPresetDto[];
+    /**
+     * Cosmetic item preset 3 for Beta mode (if Zero) or Dress-up mode (if Angelic Buster)
+     */
+    additionalCashItemEquipmentPreset3: CharacterCashItemEquipmentPresetDto[];
+    constructor(obj: CharacterCashItemEquipmentBody);
+}
+/**
+ * Cash equipment coloring prism information
+ */
+export declare class CharacterCashItemEquipmentColoringPrismDto extends base.CharacterCashItemEquipmentColoringPrismDto {
+    /**
+     * Coloring prism color range
+     */
+    colorRange: string;
+    /**
+     * Coloring prism hue
+     */
+    hue: number;
+    /**
+     * Coloring prism saturation
+     */
+    saturation: number;
+    /**
+     * Coloring prism brightness
+     */
+    value: number;
+    constructor(obj: CharacterCashItemEquipmentColoringPrismBody);
+}
+/**
+ * Cash equipment option
+ */
+export declare class CharacterCashItemEquipmentOptionDto extends base.CharacterCashItemEquipmentOptionDto {
+    /**
+     * Option type
+     */
+    optionType: string;
+    /**
+     * Option value
+     */
+    optionValue: string;
+    constructor(obj: CharacterCashItemEquipmentOptionBody);
+}
+/**
+ * Equipped cash item preset information
+ */
+export declare class CharacterCashItemEquipmentPresetDto extends base.CharacterCashItemEquipmentPresetDto {
+    /**
+     * Cash equipment part name
+     */
+    cashItemEquipmentPart: string;
+    /**
+     * Cash equipment slot position
+     */
+    cashItemEquipmentSlot: string;
+    /**
+     * Cash equipment name
+     */
+    cashItemName: string;
+    /**
+     * Cash equipment icon
+     */
+    cashItemIcon: string;
+    /**
+     * Cash equipment description
+     */
+    cashItemDescription: string | null;
+    /**
+     * Cash equipment option
+     */
+    cashItemOption: CharacterCashItemEquipmentOptionDto[];
+    /**
+     * Cash equipment validity period (SGT)
+     */
+    dateExpire: Date | null;
+    /**
+     * Whether the cash equipment is expired
+     */
+    isExpired: boolean | null;
+    /**
+     * Cash equipment option validity period (SGT, data with minutes set to 0)
+     */
+    dateOptionExpire: Date | null;
+    /**
+     * Whether the cash equipment option is expired
+     */
+    isOptionExpired: boolean | null;
+    /**
+     * Cash equipment label information
+     */
+    cashItemLabel: string | null;
+    /**
+     * Cash equipment coloring prism information
+     */
+    cashItemColoringPrism: CharacterCashItemEquipmentColoringPrismDto | null;
+    /**
+     * Gender compatibility for item equipment
+     */
+    itemGender: string | null;
+    constructor(obj: CharacterCashItemEquipmentPresetBody);
+}

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

@@ -0,0 +1,32 @@
+import * as base from '../../../common/dto/character/characterDojang';
+import { CharacterDojangBody } from '../../response/character/characterDojangBody';
+/**
+ * Character Mu Lung Garden highest record information
+ */
+export declare class CharacterDojangDto extends base.CharacterDojangDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Character job
+     */
+    characterClass: string | null;
+    /**
+     * World name
+     */
+    worldName: string | null;
+    /**
+     * Highest floor record in Mu Lung Garden
+     */
+    dojangBestFloor: number | null;
+    /**
+     * Achievement date of the highest Mu Lung Garden record (SGT, daily data with hours and minutes set to 0)
+     */
+    dateDojangRecord: Date | null;
+    /**
+     * Time taken to clear the highest floor in Mu Lung Garden (in seconds)
+     */
+    dojangBestTime: number | null;
+    constructor(obj: CharacterDojangBody);
+}