maplestory-openapi 2.3.2 → 2.4.1

package/types/maplestory/api/dto/union/unionArtifactCrystalDto.d.ts

@@ -0,0 +1,36 @@
+import { UnionArtifactCrystalDtoBody } from '../../response/union/unionArtifactDtoBody';
+/**
+ * 유니온 아티팩트 크리스탈 정보
+ */
+declare class UnionArtifactCrystalDto {
+    /**
+     * 아티팩트 크리스탈 명
+     */
+    name: string;
+    /**
+     * 능력치 유효 여부 (0:유효, 1:유효하지 않음)
+     */
+    validityFlag: string;
+    /**
+     * 능력치 유효 기간(KST)
+     */
+    dateExpire: Date;
+    /**
+     * 아티팩트 크리스탈 등급
+     */
+    level: number;
+    /**
+     * 아티팩트 크리스탈 첫 번째 옵션 명
+     */
+    crystalOptionName1: string;
+    /**
+     * 아티팩트 크리스탈 두 번째 옵션 명
+     */
+    crystalOptionName2: string;
+    /**
+     * 아티팩트 크리스탈 세 번째 옵션 명
+     */
+    crystalOptionName3: string;
+    constructor(obj: UnionArtifactCrystalDtoBody);
+}
+export { UnionArtifactCrystalDto };

package/types/maplestory/api/dto/union/unionArtifactDto.d.ts

@@ -0,0 +1,26 @@
+import { UnionArtifactCrystalDto } from './unionArtifactCrystalDto';
+import { UnionArtifactEffectDto } from './unionArtifactEffectDto';
+import { UnionArtifactDtoBody } from '../../response/union/unionArtifactDtoBody';
+/**
+ * 유니온 아티팩트 정보
+ */
+declare class UnionArtifactDto {
+    /**
+     * 조회 기준일
+     */
+    date: Date;
+    /**
+     * 아티팩트 효과 정보
+     */
+    unionArtifactEffect: UnionArtifactEffectDto[];
+    /**
+     * 아티팩트 크리스탈 정보
+     */
+    unionArtifactCrystal: UnionArtifactCrystalDto[];
+    /**
+     * 잔여 아티팩트 AP
+     */
+    unionArtifactRemainAp: number | null;
+    constructor(obj: UnionArtifactDtoBody);
+}
+export { UnionArtifactDto };

package/types/maplestory/api/dto/union/unionArtifactEffectDto.d.ts

@@ -0,0 +1,16 @@
+import { UnionArtifactEffectDtoBody } from '../../response/union/unionArtifactDtoBody';
+/**
+ * 유니온 아티팩트 효과 정보
+ */
+declare class UnionArtifactEffectDto {
+    /**
+     * 아티팩트 효과 명
+     */
+    name: string;
+    /**
+     * 아티팩트 효과 레벨
+     */
+    level: number;
+    constructor(obj: UnionArtifactEffectDtoBody);
+}
+export { UnionArtifactEffectDto };

package/types/maplestory/api/dto/union/unionDto.d.ts

@@ -15,6 +15,18 @@ declare class UnionDto {
      * 유니온 등급
      */
     unionGrade: string;
+    /**
+     * 아티팩트 레벨
+     */
+    unionArtifactLevel: number | null;
+    /**
+     * 보유 아티팩트 경험치
+     */
+    unionArtifactExp: number | null;
+    /**
+     * 보유 아티팩트 포인트
+     */
+    unionArtifactPoint: number | null;
     constructor(obj: UnionDtoBody);
 }
 export { UnionDto };

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

@@ -1,4 +1,3 @@
-import { AchievementRankingResponseDto } from './dto/ranking/achievementRankingResponseDto';
 import { CharacterAbilityDto } from './dto/character/characterAbilityDto';
 import { CharacterAndroidEquipmentDto } from './dto/character/characterAndroidEquipmentDto';
 import { CharacterBasicDto } from './dto/character/characterBasicDto';
@@ -19,27 +18,33 @@ import { CharacterSkillDto } from './dto/character/characterSkillDto';
 import { CharacterStatDto } from './dto/character/characterStatDto';
 import { CharacterSymbolEquipmentDto } from './dto/character/characterSymbolEquipmentDto';
 import { CharacterVMatrixDto } from './dto/character/characterVMatrixDto';
-import { CubeHistoryResponseDto } from './dto/history/cubeHistoryResponseDto';
-import { DojangRankingResponseDto } from './dto/ranking/dojangRankingResponseDto';
 import { GuildBasicDto } from './dto/guild/guildBasicDto';
 import { GuildDto } from './dto/guild/guildDto';
-import { GuildRankingResponseDto } from './dto/ranking/guildRankingResponseDto';
+import { CubeHistoryResponseDto } from './dto/history/cubeHistoryResponseDto';
+import { PotentialHistoryResponseDto } from './dto/history/potentialHistoryResponseDto';
+import { StarforceHistoryResponseDto } from './dto/history/starforceHistoryResponseDto';
 import { InspectionInfoDto } from './dto/inspectionInfoDto';
+import { AchievementRankingResponseDto } from './dto/ranking/achievementRankingResponseDto';
+import { DojangRankingResponseDto } from './dto/ranking/dojangRankingResponseDto';
+import { GuildRankingResponseDto } from './dto/ranking/guildRankingResponseDto';
 import { OverallRankingResponseDto } from './dto/ranking/overallRankingResponseDto';
 import { TheSeedRankingResponseDto } from './dto/ranking/theSeedRankingResponseDto';
+import { UnionRankingResponseDto } from './dto/ranking/unionRankingResponseDto';
+import { UnionArtifactDto } from './dto/union/unionArtifactDto';
 import { UnionDto } from './dto/union/unionDto';
 import { UnionRaiderDto } from './dto/union/unionRaiderDto';
-import { UnionRankingResponseDto } from './dto/ranking/unionRankingResponseDto';
-import { StarforceHistoryResponseDto } from './dto/history/starforceHistoryResponseDto';
 /**
  * MapleStory OpenAPI client.<br>
  * This is an implementation of <a href="https://openapi.nexon.com/game/maplestory">MapleStory API</a>
  */
 declare class MapleStoryApi {
     private readonly apiKey;
-    private static BASE_URL;
-    private static kstOffset;
-    timeout: number;
+    private readonly client;
+    private static readonly BASE_URL;
+    private static readonly DEFAULT_TIMEOUT;
+    private static readonly kstOffset;
+    get timeout(): number;
+    set timeout(value: number);
     constructor(apiKey: string);
     /**
      * 캐릭터 식별자(ocid)를 조회합니다.
@@ -261,7 +266,7 @@ declare class MapleStoryApi {
      * @param ocid 캐릭터 식별자
      * @param dateOptions 조회 기준일 (KST)
      */
-    getUnionInfo(ocid: string, dateOptions?: DateOptions): Promise<UnionDto>;
+    getUnion(ocid: string, dateOptions?: DateOptions): Promise<UnionDto>;
     /**
      * 유니온 공격대 정보를 조회합니다.
      * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
@@ -271,7 +276,17 @@ declare class MapleStoryApi {
      * @param ocid 캐릭터 식별자
      * @param dateOptions 조회 기준일 (KST)
      */
-    getUnionRaiderInfo(ocid: string, dateOptions?: DateOptions): Promise<UnionRaiderDto>;
+    getUnionRaider(ocid: string, dateOptions?: DateOptions): Promise<UnionRaiderDto>;
+    /**
+     * 유니온 아티팩트 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 유니온 정보 조회 API는 일자별 데이터로 매일 오전 1시부터 전일 데이터 조회가 가능합니다. (예를 들어, 12월 22일 데이터를 조회하면 22일 00시부터 23일의 00시 사이의 데이터가 조회됩니다.)
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getUnionArtifact(ocid: string, dateOptions?: DateOptions): Promise<UnionArtifactDto>;
     /**
      * 길드 식별자(oguild_id) 정보를 조회합니다.
      * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
@@ -347,6 +362,35 @@ declare class MapleStoryApi {
      * @param cursor 페이징 처리를 위한 cursor
      */
     getCubeHistory(count: number, cursor: string): Promise<CubeHistoryResponseDto>;
+    /**
+     * 잠재능력 재설정 이용 결과를 조회합니다.
+     * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
+     * - e.g. 오늘 오후 3시 5분 잠재능력 재설정 정보 조회 시, 어제의 잠재능력 재설정 정보 데이터를 조회할 수 있습니다.
+     * - 2024년 1월 25일 데이터부터 조회할 수 있습니다.
+     *
+     * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
+     */
+    getPotentialHistory(count: number): Promise<PotentialHistoryResponseDto>;
+    /**
+     * 지목한 날짜의 잠재능력 재설정 이용 결과를 조회합니다.
+     * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
+     * - e.g. 오늘 오후 3시 5분 잠재능력 재설정 정보 조회 시, 어제의 잠재능력 재설정 정보 데이터를 조회할 수 있습니다.
+     * - 2024년 1월 25일 데이터부터 조회할 수 있습니다.
+     *
+     * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getPotentialHistory(count: number, dateOptions: DateOptions): Promise<PotentialHistoryResponseDto>;
+    /**
+     * 잠재능력 재설정 이용 결과를 조회합니다.
+     * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
+     * - e.g. 오늘 오후 3시 5분 잠재능력 재설정 정보 조회 시, 어제의 잠재능력 재설정 정보 데이터를 조회할 수 있습니다.
+     * - 2024년 1월 25일 데이터부터 조회할 수 있습니다.
+     *
+     * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
+     * @param cursor 페이징 처리를 위한 cursor
+     */
+    getPotentialHistory(count: number, cursor: string): Promise<PotentialHistoryResponseDto>;
     /**
      * 종합 랭킹 정보를 조회합니다.
      * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
@@ -412,7 +456,6 @@ declare class MapleStoryApi {
      * 서버 점검 정보를 조회합니다.
      */
     getInspectionInfo(): Promise<InspectionInfoDto>;
-    private buildHeaders;
     /**
      * API 서버의 데이터 갱신 시간에 따라 데이터가 조회 가능한 최신 날짜를 반환합니다.
      *

package/types/maplestory/api/mapleStoryApiError.d.ts

@@ -20,6 +20,8 @@ declare enum MapleStoryApiErrorCode {
     OPENAPI00004 = 3,
     OPENAPI00005 = 4,
     OPENAPI00006 = 5,
-    OPENAPI00007 = 6
+    OPENAPI00007 = 6,
+    OPENAPI00009 = 7,
+    OPENAPI00010 = 8
 }
 export { MapleStoryApiError, MapleStoryApiErrorCode };

package/types/maplestory/api/response/character/characterAbilityDtoBody.d.ts

@@ -3,10 +3,18 @@ type CharacterAbilityDtoBody = {
     ability_grade: string;
     ability_info: CharacterAbilityInfoDtoBody[];
     remain_fame: number;
+    preset_no: number;
+    ability_preset_1: CharacterAbilityPresetDtoBody;
+    ability_preset_2: CharacterAbilityPresetDtoBody;
+    ability_preset_3: CharacterAbilityPresetDtoBody;
 };
 type CharacterAbilityInfoDtoBody = {
     ability_no: string;
     ability_grade: string;
     ability_value: string;
 };
-export { CharacterAbilityDtoBody, CharacterAbilityInfoDtoBody };
+type CharacterAbilityPresetDtoBody = {
+    ability_preset_grade: string;
+    ability_info: CharacterAbilityInfoDtoBody[];
+};
+export { CharacterAbilityDtoBody, CharacterAbilityInfoDtoBody, CharacterAbilityPresetDtoBody };

package/types/maplestory/api/response/character/characterAndroidEquipmentDtoBody.d.ts

@@ -9,6 +9,14 @@ type CharacterAndroidEquipmentDtoBody = {
     android_skin_name: string | null;
     android_cash_item_equipment: CharacterAndroidCashItemEquipmentDtoBody[];
     android_ear_sensor_clip_flag: string | null;
+    android_gender: string | null;
+    android_grade: string | null;
+    android_non_humanoid_flag: string | null;
+    android_shop_usable_flag: string | null;
+    preset_no: number | null;
+    android_preset_1: CharacterAndroidEquipmentPresetDtoBody | null;
+    android_preset_2: CharacterAndroidEquipmentPresetDtoBody | null;
+    android_preset_3: CharacterAndroidEquipmentPresetDtoBody | null;
 };
 type CharacterAndroidEquipmentHairDtoBody = {
     hair_name: string | null;
@@ -22,6 +30,20 @@ type CharacterAndroidEquipmentFaceDtoBody = {
     mix_color: string | null;
     mix_rate: string;
 };
+type CharacterAndroidEquipmentPresetDtoBody = {
+    android_name: string;
+    android_nickname: string;
+    android_icon: string;
+    android_description: string;
+    android_gender: string | null;
+    android_grade: string;
+    android_skin_name: string;
+    android_hair: CharacterAndroidEquipmentHairDtoBody;
+    android_face: CharacterAndroidEquipmentFaceDtoBody;
+    android_ear_sensor_clip_flag: string;
+    android_non_humanoid_flag: string;
+    android_shop_usable_flag: string;
+};
 type CharacterAndroidCashItemEquipmentDtoBody = {
     cash_item_equipment_part: string;
     cash_item_equipment_slot: string;
@@ -44,4 +66,4 @@ type CharacterAndroidCashItemEquipmentColoringPrismDtoBody = {
     saturation: number;
     value: number;
 };
-export type { CharacterAndroidEquipmentDtoBody, CharacterAndroidEquipmentHairDtoBody, CharacterAndroidEquipmentFaceDtoBody, CharacterAndroidCashItemEquipmentDtoBody, CharacterAndroidCashItemEquipmentOptionDtoBody, CharacterAndroidCashItemEquipmentColoringPrismDtoBody, };
+export type { CharacterAndroidEquipmentDtoBody, CharacterAndroidEquipmentHairDtoBody, CharacterAndroidEquipmentFaceDtoBody, CharacterAndroidEquipmentPresetDtoBody, CharacterAndroidCashItemEquipmentDtoBody, CharacterAndroidCashItemEquipmentOptionDtoBody, CharacterAndroidCashItemEquipmentColoringPrismDtoBody, };

package/types/maplestory/api/response/character/characterCashItemEquipmentDtoBody.d.ts

@@ -3,9 +3,11 @@ type CharacterCashItemEquipmentDtoBody = {
     character_gender: string;
     character_class: string;
     preset_no: number;
+    cash_item_equipment_base: CharacterCashItemEquipmentPresetDtoBody[];
     cash_item_equipment_preset_1: CharacterCashItemEquipmentPresetDtoBody[];
     cash_item_equipment_preset_2: CharacterCashItemEquipmentPresetDtoBody[];
     cash_item_equipment_preset_3: CharacterCashItemEquipmentPresetDtoBody[];
+    additional_cash_item_equipment_base: CharacterCashItemEquipmentPresetDtoBody[];
     additional_cash_item_equipment_preset_1: CharacterCashItemEquipmentPresetDtoBody[];
     additional_cash_item_equipment_preset_2: CharacterCashItemEquipmentPresetDtoBody[];
     additional_cash_item_equipment_preset_3: CharacterCashItemEquipmentPresetDtoBody[];
@@ -21,7 +23,7 @@ type CharacterCashItemEquipmentPresetDtoBody = {
     date_option_expire: string | null;
     cash_item_label: string | null;
     cash_item_coloring_prism: CharacterCashItemEquipmentColoringPrismDtoBody | null;
-    base_preset_item_disable_flag: string;
+    item_gender: string | null;
 };
 type CharacterCashItemEquipmentOptionDtoBody = {
     option_type: string;

package/types/maplestory/api/response/character/characterItemEquipmentDtoBody.d.ts

@@ -2,7 +2,11 @@ type CharacterItemEquipmentDtoBody = {
     date: string;
     character_gender: string;
     character_class: string;
+    preset_no: number | null;
     item_equipment: CharacterItemEquipmentInfoDtoBody[];
+    item_equipment_preset_1: CharacterItemEquipmentInfoDtoBody[] | null;
+    item_equipment_preset_2: CharacterItemEquipmentInfoDtoBody[] | null;
+    item_equipment_preset_3: CharacterItemEquipmentInfoDtoBody[] | null;
     title: CharacterItemEquipmentTitleDtoBody | null;
     dragon_equipment: CharacterItemEquipmentInfoDtoBody[];
     mechanic_equipment: CharacterItemEquipmentInfoDtoBody[];

package/types/maplestory/api/response/character/characterLinkSkillDtoBody.d.ts

@@ -1,8 +1,14 @@
 type CharacterLinkSkillDtoBody = {
     date: string;
     character_class: string;
-    character_link_skill: CharacterLinkSkillInfoDtoBody;
+    character_link_skill: CharacterLinkSkillInfoDtoBody[];
+    character_link_skill_preset_1: CharacterLinkSkillInfoDtoBody[];
+    character_link_skill_preset_2: CharacterLinkSkillInfoDtoBody[];
+    character_link_skill_preset_3: CharacterLinkSkillInfoDtoBody[];
     character_owned_link_skill: CharacterLinkSkillInfoDtoBody;
+    character_owned_link_skill_preset_1: CharacterLinkSkillInfoDtoBody | null;
+    character_owned_link_skill_preset_2: CharacterLinkSkillInfoDtoBody | null;
+    character_owned_link_skill_preset_3: CharacterLinkSkillInfoDtoBody | null;
 };
 type CharacterLinkSkillInfoDtoBody = {
     skill_name: string;

package/types/maplestory/api/response/character/characterPetEquipmentDtoBody.d.ts

@@ -1,32 +1,38 @@
 type CharacterPetEquipmentDtoBody = {
     date: string;
-    pet_1_name: string;
-    pet_1_nickname: string;
-    pet_1_icon: string;
-    pet_1_description: string;
-    pet_1_equipment: CharacterPetEquipmentItemDtoBody;
-    pet_1_auto_skill: CharacterPetEquipmentAutoSkillDtoBody;
+    pet_1_name: string | null;
+    pet_1_nickname: string | null;
+    pet_1_icon: string | null;
+    pet_1_description: string | null;
+    pet_1_equipment: CharacterPetEquipmentItemDtoBody | null;
+    pet_1_auto_skill: CharacterPetEquipmentAutoSkillDtoBody | null;
     pet_1_pet_type: string | null;
     pet_1_skill: string[];
-    pet_1_date_expire: string;
-    pet_2_name: string;
-    pet_2_nickname: string;
-    pet_2_icon: string;
-    pet_2_description: string;
-    pet_2_equipment: CharacterPetEquipmentItemDtoBody;
-    pet_2_auto_skill: CharacterPetEquipmentAutoSkillDtoBody;
+    pet_1_date_expire: string | null;
+    pet_1_appearance: string | null;
+    pet_1_appearance_icon: string | null;
+    pet_2_name: string | null;
+    pet_2_nickname: string | null;
+    pet_2_icon: string | null;
+    pet_2_description: string | null;
+    pet_2_equipment: CharacterPetEquipmentItemDtoBody | null;
+    pet_2_auto_skill: CharacterPetEquipmentAutoSkillDtoBody | null;
     pet_2_pet_type: string | null;
     pet_2_skill: string[];
-    pet_2_date_expire: string;
-    pet_3_name: string;
-    pet_3_nickname: string;
-    pet_3_icon: string;
-    pet_3_description: string;
-    pet_3_equipment: CharacterPetEquipmentItemDtoBody;
-    pet_3_auto_skill: CharacterPetEquipmentAutoSkillDtoBody;
+    pet_2_date_expire: string | null;
+    pet_2_appearance: string | null;
+    pet_2_appearance_icon: string | null;
+    pet_3_name: string | null;
+    pet_3_nickname: string | null;
+    pet_3_icon: string | null;
+    pet_3_description: string | null;
+    pet_3_equipment: CharacterPetEquipmentItemDtoBody | null;
+    pet_3_auto_skill: CharacterPetEquipmentAutoSkillDtoBody | null;
     pet_3_pet_type: string | null;
     pet_3_skill: string[];
-    pet_3_date_expire: string;
+    pet_3_date_expire: string | null;
+    pet_3_appearance: string | null;
+    pet_3_appearance_icon: string | null;
 };
 type CharacterPetEquipmentItemDtoBody = {
     item_name: string | null;
@@ -34,7 +40,9 @@ type CharacterPetEquipmentItemDtoBody = {
     item_description: string | null;
     item_option: CharacterPetEquipmentItemOptionDtoBody[];
     scroll_upgrade: number;
-    scroll_upgradeable: number;
+    scroll_upgradable: number;
+    item_shape: string | null;
+    item_shape_icon: string | null;
 };
 type CharacterPetEquipmentItemOptionDtoBody = {
     option_type: string;

package/types/maplestory/api/response/history/potentialHistoryResponseDtoBody.d.ts

@@ -0,0 +1,29 @@
+type PotentialHistoryResponseDtoBody = {
+    count: number;
+    potential_history: PotentialHistoryDtoBody[];
+    next_cursor: string | null;
+};
+type PotentialHistoryDtoBody = {
+    id: string;
+    character_name: string;
+    date_create: string;
+    potential_type: string;
+    item_upgrade_result: string;
+    miracle_time_flag: string;
+    item_equipment_part: string;
+    item_level: number;
+    target_item: string;
+    potential_option_grade: string;
+    additional_potential_option_grade: string;
+    upgrade_guarantee: boolean;
+    upgrade_guarantee_count: number;
+    before_potential_option: PotentialResultOptionDtoBody[];
+    before_additional_potential_option: PotentialResultOptionDtoBody[];
+    after_potential_option: PotentialResultOptionDtoBody[];
+    after_additional_potential_option: PotentialResultOptionDtoBody[];
+};
+type PotentialResultOptionDtoBody = {
+    value: string;
+    grade: string;
+};
+export type { PotentialHistoryResponseDtoBody, PotentialHistoryDtoBody, PotentialResultOptionDtoBody, };

package/types/maplestory/api/response/union/unionArtifactDtoBody.d.ts

@@ -0,0 +1,20 @@
+type UnionArtifactDtoBody = {
+    date: string;
+    union_artifact_effect: UnionArtifactEffectDtoBody[];
+    union_artifact_crystal: UnionArtifactCrystalDtoBody[];
+    union_artifact_remain_ap: number | null;
+};
+type UnionArtifactEffectDtoBody = {
+    name: string;
+    level: number;
+};
+type UnionArtifactCrystalDtoBody = {
+    name: string;
+    validity_flag: string;
+    date_expire: string;
+    level: number;
+    crystal_option_name_1: string;
+    crystal_option_name_2: string;
+    crystal_option_name_3: string;
+};
+export type { UnionArtifactDtoBody, UnionArtifactEffectDtoBody, UnionArtifactCrystalDtoBody, };

package/types/maplestory/api/response/union/unionDtoBody.d.ts

@@ -2,5 +2,8 @@ type UnionDtoBody = {
     date: string;
     union_level: number;
     union_grade: string;
+    union_artifact_level: number | null;
+    union_artifact_exp: number | null;
+    union_artifact_point: number | null;
 };
 export type { UnionDtoBody };