maplestory-openapi 2.10.0 → 2.11.1

package/dist/index.js

@@ -2559,7 +2559,11 @@ class CharacterAndroidCashItemEquipmentDto {
     /**
      * 안드로이드 캐시 아이템 옵션 유효 기간 (KST, 시간 단위 데이터로 분은 일괄 0으로 표기)
      */
-    dateOptionExpire;
+    dateOptionExpire = null;
+    /**
+     * 안드로이드 캐시 아이템 옵션 유효 기간 만료 여부
+     */
+    isOptionExpired = null;
     /**
      * 안드로이드 캐시 아이템 라벨 정보 (스페셜라벨, 레드라벨, 블랙라벨, 마스터라벨)
      */
@@ -2577,13 +2581,18 @@ class CharacterAndroidCashItemEquipmentDto {
         this.cashItemDescription = cash_item_description;
         this.cashItemOption = cash_item_option.map((option) => new CharacterAndroidCashItemEquipmentOptionDto(option));
         this.dateExpire = date_expire ? new Date(date_expire) : null;
-        this.dateOptionExpire = date_option_expire
-            ? new Date(date_option_expire)
-            : null;
         this.cashItemLabel = cash_item_label;
         this.cashItemColoringPrism = cash_item_coloring_prism
             ? new CharacterAndroidCashItemEquipmentColoringPrismDto(cash_item_coloring_prism)
             : null;
+        if (date_option_expire === 'expired') {
+            this.isOptionExpired = true;
+        }
+        else if (typeof date_option_expire === 'string') {
+            this.dateOptionExpire = date_option_expire
+                ? new Date(date_option_expire)
+                : null;
+        }
     }
 }
 
@@ -3173,7 +3182,11 @@ class CharacterCashItemEquipmentPresetDto {
     /**
      * 캐시 장비 옵션 유효 기간 (KST, 시간 단위 데이터로 분은 일괄 0으로 표기)
      */
-    dateOptionExpire;
+    dateOptionExpire = null;
+    /**
+     * 캐시 장비 옵션 유효 기간 만료 여부
+     */
+    isOptionExpired = null;
     /**
      * 캐시 장비 라벨 정보
      */
@@ -3186,21 +3199,33 @@ class CharacterCashItemEquipmentPresetDto {
      * 아이템 장착 가능 성별
      */
     itemGender;
+    /**
+     * 스킬명
+     */
+    skills;
     constructor(obj) {
-        const { cash_item_equipment_part, cash_item_equipment_slot, cash_item_name, cash_item_icon, cash_item_description, cash_item_option, date_expire, date_option_expire, cash_item_label, cash_item_coloring_prism, item_gender, } = obj;
+        const { cash_item_equipment_part, cash_item_equipment_slot, cash_item_name, cash_item_icon, cash_item_description, cash_item_option, date_expire, date_option_expire, cash_item_label, cash_item_coloring_prism, item_gender, skills, } = obj;
         this.cashItemEquipmentPart = cash_item_equipment_part;
         this.cashItemEquipmentSlot = cash_item_equipment_slot;
         this.cashItemName = cash_item_name;
         this.cashItemIcon = cash_item_icon;
         this.cashItemDescription = cash_item_description;
         this.cashItemOption = cash_item_option.map((option) => new CharacterCashItemEquipmentOptionDto(option));
-        this.dateExpire = date_expire;
-        this.dateOptionExpire = date_option_expire;
+        this.dateExpire = date_expire ? new Date(date_expire) : null;
         this.cashItemLabel = cash_item_label;
         this.cashItemColoringPrism = cash_item_coloring_prism
             ? new CharacterCashItemEquipmentColoringPrismDto(cash_item_coloring_prism)
             : null;
         this.itemGender = item_gender;
+        this.skills = skills;
+        if (date_option_expire === 'expired') {
+            this.isOptionExpired = true;
+        }
+        else if (typeof date_option_expire === 'string') {
+            this.dateOptionExpire = date_option_expire
+                ? new Date(date_option_expire)
+                : null;
+        }
     }
 }
 
@@ -4030,7 +4055,7 @@ class CharacterItemEquipmentExceptionalOptionDto {
         this.maxMp = max_mp;
         this.attackPower = attack_power;
         this.magicPower = magic_power;
-        this.exceptionalUpgrade = exceptional_upgrade;
+        this.exceptionalUpgrade = exceptional_upgrade ?? 0;
     }
 }
 
@@ -4684,6 +4709,45 @@ class CharacterItemEquipmentMechanicInfoDto {
     }
 }
 
+/**
+ * 캐릭터 외형 설정에 등록한 훈장 외형 정보
+ */
+class CharacterItemEquipmentMedalShapeDto {
+    /**
+     * 외형 설정에 등록한 훈장 장비 명
+     */
+    medalShapeName;
+    /**
+     * 외형 설정에 등록한 훈장 아이콘
+     */
+    medalShapeIcon;
+    /**
+     * 외형 설정에 등록한 훈장 설명
+     */
+    medalShapeDescription;
+    /**
+     * 외형 설정에 등록한 훈장의 모루 적용 장비 명
+     */
+    medalShapeChangedName;
+    /**
+     * 외형 설정에 등록한 훈장의 모루 적용 아이콘
+     */
+    medalShapeChangedIcon;
+    /**
+     * 외형 설정에 등록한 훈장의 모루 적용 훈장 설명
+     */
+    medalShapeChangedDescription;
+    constructor(obj) {
+        const { medal_shape_name, medal_shape_icon, medal_shape_description, medal_shape_changed_name, medal_shape_changed_icon, medal_shape_changed_description, } = obj;
+        this.medalShapeName = medal_shape_name;
+        this.medalShapeIcon = medal_shape_icon;
+        this.medalShapeDescription = medal_shape_description;
+        this.medalShapeChangedName = medal_shape_changed_name;
+        this.medalShapeChangedIcon = medal_shape_changed_icon;
+        this.medalShapeChangedDescription = medal_shape_changed_description;
+    }
+}
+
 /**
  * 캐릭터 칭호 아이템 정보
  */
@@ -4712,12 +4776,27 @@ class CharacterItemEquipmentTitleDto {
      * 칭호 옵션 유효 기간 만료 여부
      */
     isOptionExpired = null;
+    /**
+     * 외형 설정에 등록한 칭호 장비 명
+     */
+    titleShapeName;
+    /**
+     * 외형 설정에 등록한 칭호 아이콘
+     */
+    titleShapeIcon;
+    /**
+     * 외형 설정에 등록한 칭호 설명
+     */
+    titleShapeDescription;
     constructor(obj) {
-        const { title_name, title_icon, title_description, date_expire, date_option_expire, } = obj;
+        const { title_name, title_icon, title_description, date_expire, date_option_expire, title_shape_name, title_shape_icon, title_shape_description, } = obj;
         this.titleName = title_name;
         this.titleIcon = title_icon;
         this.titleDescription = title_description;
         this.dateExpire = date_expire ? new Date(date_expire) : null;
+        this.titleShapeName = title_shape_name;
+        this.titleShapeIcon = title_shape_icon;
+        this.titleShapeDescription = title_shape_description;
         if (date_option_expire === 'expired') {
             this.isOptionExpired = true;
         }
@@ -4769,6 +4848,10 @@ class CharacterItemEquipmentDto {
      * 칭호 정보
      */
     title;
+    /**
+     * 외형 설정에 등록한 훈장 외형 정보
+     */
+    medalShape;
     /**
      * 에반 드래곤 장비 정보 (에반인 경우 응답)
      */
@@ -4778,7 +4861,7 @@ class CharacterItemEquipmentDto {
      */
     mechanicEquipment;
     constructor(obj) {
-        const { date, character_gender, character_class, preset_no, item_equipment, item_equipment_preset_1, item_equipment_preset_2, item_equipment_preset_3, title, dragon_equipment, mechanic_equipment, } = obj;
+        const { date, character_gender, character_class, preset_no, item_equipment, item_equipment_preset_1, item_equipment_preset_2, item_equipment_preset_3, title, medal_shape, dragon_equipment, mechanic_equipment, } = obj;
         this.date = date ? new Date(date) : null;
         this.characterGender = character_gender;
         this.characterClass = character_class;
@@ -4788,6 +4871,7 @@ class CharacterItemEquipmentDto {
         this.itemEquipmentPreset2 = item_equipment_preset_2 ? item_equipment_preset_2.map((equipment) => new CharacterItemEquipmentInfoDto(equipment)) : null;
         this.itemEquipmentPreset3 = item_equipment_preset_3 ? item_equipment_preset_3.map((equipment) => new CharacterItemEquipmentInfoDto(equipment)) : null;
         this.title = title ? new CharacterItemEquipmentTitleDto(title) : null;
+        this.medalShape = medal_shape ? new CharacterItemEquipmentMedalShapeDto(medal_shape) : null;
         this.dragonEquipment = dragon_equipment.map((equipment) => new CharacterItemEquipmentDragonInfoDto(equipment));
         this.mechanicEquipment = mechanic_equipment.map((equipment) => new CharacterItemEquipmentMechanicInfoDto(equipment));
     }
@@ -7413,6 +7497,73 @@ const errorMap = {
     ['OPENAPI00011']: exports.MapleStoryApiErrorCode.OPENAPI00011,
 };
 
+/**
+ * 유니온 챔피언 휘장 정보
+ */
+class UnionChampionBadgeInfoDto {
+    /**
+     * 유니온 챔피언 휘장 효과
+     */
+    stat;
+    constructor(obj) {
+        const { stat } = obj;
+        this.stat = stat;
+    }
+}
+
+/**
+ * 유니온 챔피언 상세 정보
+ */
+class UnionChampionInfoDto {
+    /**
+     * 유니온 챔피언 슬롯
+     */
+    championSlot;
+    /**
+     * 유니온 챔피언 등급
+     */
+    championGrade;
+    /**
+     * 유니온 챔피언 캐릭터의 직업
+     */
+    championClass;
+    /**
+     * 챔피언 휘장 효과
+     */
+    championBadgeInfo;
+    constructor(obj) {
+        const { champion_slot, champion_grade, champion_class, champion_badge_info } = obj;
+        this.championSlot = champion_slot;
+        this.championGrade = champion_grade;
+        this.championClass = champion_class;
+        this.championBadgeInfo = champion_badge_info.map((info) => new UnionChampionBadgeInfoDto(info));
+    }
+}
+
+/**
+ * 유니온 챔피언 정보
+ */
+class UnionChampionDto {
+    /**
+     * 조회 기준일
+     */
+    date;
+    /**
+     * 유니온 챔피언 정보
+     */
+    unionChampion;
+    /**
+     * 유니온 챔피언 휘장 정보
+     */
+    championBadgeTotalInfo;
+    constructor(obj) {
+        const { date, union_champion, champion_badge_total_info } = obj;
+        this.date = date ? new Date(date) : null;
+        this.unionChampion = union_champion.map((info) => new UnionChampionInfoDto(info));
+        this.championBadgeTotalInfo = champion_badge_total_info.map((info) => new UnionChampionBadgeInfoDto(info));
+    }
+}
+
 dayjs__default["default"].extend(timezone);
 dayjs__default["default"].extend(utc);
 /**
@@ -8166,6 +8317,35 @@ class MapleStoryApi {
         });
         return new UnionArtifactDto(data);
     }
+    /**
+     * 유니온 챔피언 정보를 조회합니다.<br>
+     * 유니온 챔피언 정보는 2025년 2월 20일 메이플스토리 점검 이후 데이터부터 조회 가능합니다.<br>
+     * - 메이플스토리 게임 데이터는 평균 15분 후 확인 가능합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 과거 데이터는 원하는 일자를 입력해 조회할 수 있으며, 전일 데이터는 다음날 오전 2시부터 확인할 수 있습니다. (12월 22일 데이터 조회 시, 22일 00시부터 23일 00시 사이 데이터가 조회 됩니다.)
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    async getUnionChampion(ocid, dateOptions) {
+        const path = 'maplestory/v1/user/union-champion';
+        const date = dateOptions
+            ? MapleStoryApi.toDateString({
+                year: 2023,
+                month: 12,
+                day: 21,
+            }, dateOptions)
+            : undefined;
+        const query = {
+            ocid: ocid,
+            date: date,
+        };
+        const { data } = await this.client.get(path, {
+            params: query,
+        });
+        return new UnionChampionDto(data);
+    }
     //#endregion
     //#region 길드 정보 조회
     /**