maplestory-openapi 1.1.0 → 2.1.0

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

@@ -1,46 +1,787 @@
 import { CubeHistoryResponseDto } from "./dto/cubeHistoryResponseDto";
 import { InspectionInfoDto } from "./dto/inspectionInfoDto";
+import { CharacterDto } from "./dto/characterDto";
+import { CharacterBasicDto } from "./dto/characterBasicDto";
+import { CharacterPopularityDto } from "./dto/characterPopularityDto";
+import { CharacterStatDto } from "./dto/characterStatDto";
+import { CharacterHyperStatDto } from "./dto/characterHyperStatDto";
+import { CharacterPropensityDto } from "./dto/characterPropensityDto";
+import { CharacterAbilityDto } from "./dto/characterAbilityDto";
+import { CharacterItemEquipmentDto } from "./dto/characterItemEquipmentDto";
+import { CharacterCashItemEquipmentDto } from "./dto/characterCashItemEquipmentDto";
+import { CharacterSymbolEquipmentDto } from "./dto/characterSymbolEquipmentDto";
+import { CharacterSetEffectDto } from "./dto/characterSetEffectDto";
+import { CharacterBeautyEquipmentDto } from "./dto/characterBeautyEquipmentDto";
+import { CharacterAndroidEquipmentDto } from "./dto/characterAndroidEquipmentDto";
+import { CharacterPetEquipmentDto } from "./dto/characterPetEquipmentDto";
+import { CharacterSkillDto } from "./dto/characterSkillDto";
+import { CharacterLinkSkillDto } from "./dto/characterLinkSkillDto";
+import { CharacterVMatrixDto } from "./dto/characterVMatrixDto";
+import { CharacterHexaMatrixDto } from "./dto/characterHexaMatrixDto";
+import { CharacterDojangDto } from "./dto/characterDojangDto";
+import { CharacterHexaMatrixStatDto } from "./dto/characterHexaMatrixStatDto";
+import { UnionDto } from "./dto/unionDto";
+import { UnionRaiderDto } from "./dto/unionRaiderDto";
+import { GuildDto } from "./dto/guildDto";
+import { GuildBasicDto } from "./dto/guildBasicDto";
+import { OverallRankingResponseDto } from "./dto/overallRankingResponseDto";
+import { UnionRankingResponseDto } from "./dto/unionRankingResponseDto";
+import { GuildRankingResponseDto } from "./dto/guildRankingResponseDto";
+import { DojangRankingResponseDto } from "./dto/dojangRankingResponseDto";
+import { TheSeedRankingResponseDto } from "./dto/theSeedRankingResponseDto";
+import { AchievementRankingResponseDto } from "./dto/achievementRankingResponseDto";
+/**
+ * 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 baseUrl;
+    private static BASE_URL;
     private static kstOffset;
     timeout: number;
     constructor(apiKey: string);
     /**
-     * 오늘 날짜의 확률형 아이템 큐브의 사용 결과를 조회합니다.<br>
-     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.<br>
-     * 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
+     * 캐릭터 식별자(ocid)를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
      *
-     * @param count 한번에 가져오려는 결과의 갯수(최소 10, 최대 1000) Default value : 10
+     * @param characterName    캐릭터 명
      */
-    getCubeResult(count: number): Promise<CubeHistoryResponseDto>;
+    getCharacter(characterName: string): Promise<CharacterDto>;
     /**
-     * 지목한 날짜의 확률형 아이템 큐브의 사용 결과를 조회합니다.<br>
-     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.<br>
-     * 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
+     * 기본 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
      *
-     * @param count 한번에 가져오려는 결과의 갯수(최소 10, 최대 1000) Default value : 10
-     * @param dateOptions 조회할 연월일 날짜 정보
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
      */
-    getCubeResult(count: number, dateOptions: DateOptions): Promise<CubeHistoryResponseDto>;
+    getCharacterBasicInfo(ocid: string, dateOptions?: DateOptions): Promise<CharacterBasicDto>;
     /**
-     * 확률형 아이템 큐브의 사용 결과를 조회합니다.<br>
-     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.<br>
-     * 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
+     * 인기도 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
      *
-     * @param count 한번에 가져오려는 결과의 갯수(최소 10, 최대 1000) Default value : 10
-     * @param cursor
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
      */
-    getCubeResult(count: number, cursor: string): Promise<CubeHistoryResponseDto>;
+    getCharacterPopularity(ocid: string, dateOptions?: DateOptions): Promise<CharacterPopularityDto>;
+    /**
+     * 종합 능력치 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterStat(ocid: string, dateOptions?: DateOptions): Promise<CharacterStatDto>;
+    /**
+     * 하이퍼스탯 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterHyperStat(ocid: string, dateOptions?: DateOptions): Promise<CharacterHyperStatDto>;
+    /**
+     * 성향 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterPropensity(ocid: string, dateOptions?: DateOptions): Promise<CharacterPropensityDto>;
+    /**
+     * 어빌리티 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterAbility(ocid: string, dateOptions?: DateOptions): Promise<CharacterAbilityDto>;
+    /**
+     * 장착한 장비 중 캐시 장비를 제외한 나머지 장비 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterItemEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterItemEquipmentDto>;
+    /**
+     * 장착한 캐시 장비 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterCashItemEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterCashItemEquipmentDto>;
+    /**
+     * 장착한 심볼 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterSymbolEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterSymbolEquipmentDto>;
+    /**
+     * 적용받고 있는 세트 효과 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterSetEffect(ocid: string, dateOptions?: DateOptions): Promise<CharacterSetEffectDto>;
+    /**
+     * 장착 중인 헤어, 성형, 피부 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterBeautyEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterBeautyEquipmentDto>;
+    /**
+     * 장착한 안드로이드 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterAndroidEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterAndroidEquipmentDto>;
+    /**
+     * 장착한 펫 및 펫 스킬, 장비 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterPetEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterPetEquipmentDto>;
+    /**
+     * 캐릭터 스킬과 하이퍼 스킬 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param characterSkillGrade 조회하고자 하는 전직 차수
+     *  - 0: 0차 스킬 및 제로 공용스킬
+     *  - 1: 1차 스킬
+     *  - 1.5: 1.5차 스킬
+     *  - 2: 2차 스킬
+     *  - 2.5: 2.5차 스킬
+     *  - 3: 3차 스킬
+     *  - 4: 4차 스킬 및 제로 알파/베타 스킬
+     *  - hyperpassive: 하이퍼 패시브 스킬
+     *  - hyperactive: 하이퍼 액티브 스킬
+     *  - 5: 5차 스킬
+     *  - 6: 6차 스킬
+     *  @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterSkill(ocid: string, characterSkillGrade: string, dateOptions?: DateOptions): Promise<CharacterSkillDto>;
+    /**
+     * 장착 링크 스킬 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterLinkSkill(ocid: string, dateOptions?: DateOptions): Promise<CharacterLinkSkillDto>;
+    /**
+     * V매트릭스 슬롯 정보와 장착한 V코어 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterVMatrix(ocid: string, dateOptions?: DateOptions): Promise<CharacterVMatrixDto>;
+    /**
+     * HEXA 매트릭스에 장착한 HEXA 코어 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterHexaMatrix(ocid: string, dateOptions?: DateOptions): Promise<CharacterHexaMatrixDto>;
+    /**
+     * HEXA 매트릭스에 설정한 HEXA 스탯 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterHexaMatrixStat(ocid: string, dateOptions?: DateOptions): Promise<CharacterHexaMatrixStatDto>;
+    /**
+     * 캐릭터 무릉도장 최고 기록 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterDojang(ocid: string, dateOptions?: DateOptions): Promise<CharacterDojangDto>;
+    /**
+     * 유니온 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOption 조회 기준일 (KST)
+     */
+    getUnionInfo(ocid: string, dateOption?: DateOptions): Promise<UnionDto>;
+    /**
+     * 유니온 공격대 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOption 조회 기준일 (KST)
+     */
+    getUnionRaiderInfo(ocid: string, dateOption?: DateOptions): Promise<UnionRaiderDto>;
+    /**
+     * 길드 식별자(oguild_id) 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param guildName 길드 명
+     * @param worldName 월드 명
+     */
+    getGuild(guildName: string, worldName: string): Promise<GuildDto>;
+    /**
+     * 길드 기본 정보를 조회합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 오전 1시부터 전일 데이터 조회가 가능합니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param guildId 길드 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getGuildBasic(guildId: string, dateOptions?: DateOptions): Promise<GuildBasicDto>;
+    /**
+     * 오늘 날짜의 큐브 사용 결과를 조회합니다.
+     * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
+     * - e.g. 오늘 오후 3시 5분 큐브 확률 정보 조회 시, 어제의 큐브 확률 정보 데이터를 조회할 수 있습니다.
+     * - 2022년 11월 25일 데이터부터 조회할 수 있습니다.
+     *
+     * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
+     */
+    getCubeHistory(count: number): Promise<CubeHistoryResponseDto>;
+    /**
+     * 지목한 날짜의 큐브 사용 결과를 조회합니다.
+     * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
+     * - e.g. 오늘 오후 3시 5분 큐브 확률 정보 조회 시, 어제의 큐브 확률 정보 데이터를 조회할 수 있습니다.
+     * - 2022년 11월 25일 데이터부터 조회할 수 있습니다.
+     *
+     * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCubeHistory(count: number, dateOptions: DateOptions): Promise<CubeHistoryResponseDto>;
+    /**
+     * 큐브 사용 결과를 조회합니다.
+     * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
+     * - e.g. 오늘 오후 3시 5분 큐브 확률 정보 조회 시, 어제의 큐브 확률 정보 데이터를 조회할 수 있습니다.
+     * - 2022년 11월 25일 데이터부터 조회할 수 있습니다.
+     *
+     * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
+     * @param cursor 페이징 처리를 위한 cursor
+     */
+    getCubeHistory(count: number, cursor: string): Promise<CubeHistoryResponseDto>;
+    /**
+     * 종합 랭킹 정보를 조회합니다.
+     * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
+     * - 오전 8시 30분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param filterOptions 검색 기준
+     * @param dateOptions 조회 기준일 (KST).
+     *
+     */
+    getOverallRanking(filterOptions?: OverallRankingApiFilterOptions, dateOptions?: DateOptions): Promise<OverallRankingResponseDto>;
+    /**
+     * 유니온 랭킹 정보를 조회합니다.
+     * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
+     * - 오전 8시 30분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param filterOptions 검색 기준
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getUnionRanking(filterOptions?: UnionRankingApiFilterOptions, dateOptions?: DateOptions): Promise<UnionRankingResponseDto>;
+    /**
+     * 길드 랭킹 정보를 조회합니다.
+     * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
+     * - 오전 8시 30분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param filterOptions 검색 기준
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getGuildRanking(filterOptions?: GuildRankingApiFilterOptions, dateOptions?: DateOptions): Promise<GuildRankingResponseDto>;
+    /**
+     * 무릉도장 랭킹 정보를 조회합니다.
+     * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
+     * - 오전 8시 30분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param filterOptions 검색 기준
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getDojangRanking(filterOptions?: DojangRankingApiFilterOptions, dateOptions?: DateOptions): Promise<DojangRankingResponseDto>;
+    /**
+     * 더 시드 랭킹 정보를 조회합니다.
+     * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
+     * - 오전 8시 30분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param filterOptions 검색 기준
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getSeedRanking(filterOptions?: TheSeedRankingApiFilterOptions, dateOptions?: DateOptions): Promise<TheSeedRankingResponseDto>;
+    /**
+     * 업적 랭킹 정보를 조회합니다.
+     * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
+     * - 오전 8시 30분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param filterOptions 검색 기준
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getAchievementRanking(filterOptions?: AchievementRankingApiFilterOptions, dateOptions?: DateOptions): Promise<AchievementRankingResponseDto>;
     /**
      * 서버 점검 정보를 조회합니다.
+     * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
+     * - 오전 8시 30분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
      */
     getInspectionInfo(): Promise<InspectionInfoDto>;
     private buildHeaders;
+    private static toDateString;
 }
+type OverallRankingApiFilterOptions = {
+    /**
+     * 월드 명
+     *
+     * - 스카니아
+     * - 베라
+     * - 루나
+     * - 제니스
+     * - 크로아
+     * - 유니온
+     * - 엘리시움
+     * - 이노시스
+     * - 레드
+     * - 오로라
+     * - 아케인
+     * - 노바
+     * - 리부트
+     * - 리부트2
+     * - 버닝
+     * - 버닝2
+     * - 버닝3
+     */
+    worldName?: string;
+    /**
+     * 월드 타입 (0:일반, 1:리부트) (기본 값은 0이며, world_name 입력 시 미 반영)
+     */
+    worldType?: number;
+    /**
+     * 직업 및 전직
+     * - 초보자-전체 전직
+     * - 전사-전체 전직
+     * - 전사-검사
+     * - 전사-파이터
+     * - 전사-페이지
+     * - 전사-스피어맨
+     * - 전사-크루세이더
+     * - 전사-나이트
+     * - 전사-버서커
+     * - 전사-히어로
+     * - 전사-팔라딘
+     * - 전사-다크나이트
+     * - 마법사-전체 전직
+     * - 마법사-매지션
+     * - 마법사-위자드(불,독)
+     * - 마법사-위자드(썬,콜)
+     * - 마법사-클레릭
+     * - 마법사-메이지(불,독)
+     * - 마법사-메이지(썬,콜)
+     * - 마법사-프리스트
+     * - 마법사-아크메이지(불,독)
+     * - 마법사-아크메이지(썬,콜)
+     * - 마법사-비숍
+     * - 궁수-전체 전직
+     * - 궁수-아처
+     * - 궁수-헌터
+     * - 궁수-사수
+     * - 궁수-레인저
+     * - 궁수-저격수
+     * - 궁수-보우마스터
+     * - 궁수-신궁
+     * - 궁수-아처(패스파인더)
+     * - 궁수-에인션트아처
+     * - 궁수-체이서
+     * - 궁수-패스파인더
+     * - 도적-전체 전직
+     * - 도적-로그
+     * - 도적-어쌔신
+     * - 도적-시프
+     * - 도적-허밋
+     * - 도적-시프마스터
+     * - 도적-나이트로드
+     * - 도적-섀도어
+     * - 도적-세미듀어러
+     * - 도적-듀어러
+     * - 도적-듀얼마스터
+     * - 도적-슬래셔
+     * - 도적-듀얼블레이더
+     * - 해적-전체 전직
+     * - 해적-해적
+     * - 해적-인파이터
+     * - 해적-건슬링거
+     * - 해적-캐논슈터
+     * - 해적-버커니어
+     * - 해적-발키리
+     * - 해적-캐논블래스터
+     * - 해적-바이퍼
+     * - 해적-캡틴
+     * - 해적-캐논마스터
+     * - 기사단-전체 전직
+     * - 기사단-노블레스
+     * - 기사단-소울마스터
+     * - 기사단-플레임위자드
+     * - 기사단-윈드브레이커
+     * - 기사단-나이트워커
+     * - 기사단-스트라이커
+     * - 기사단-미하일
+     * - 아란-전체 전직
+     * - 에반-전체 전직
+     * - 레지스탕스-전체 전직
+     * - 레지스탕스-시티즌
+     * - 레지스탕스-배틀메이지
+     * - 레지스탕스-와일드헌터
+     * - 레지스탕스-메카닉
+     * - 레지스탕스-데몬슬레이어
+     * - 레지스탕스-데몬어벤져
+     * - 레지스탕스-제논
+     * - 레지스탕스-블래스터
+     * - 메르세데스-전체 전직
+     * - 팬텀-전체 전직
+     * - 루미너스-전체 전직
+     * - 카이저-전체 전직
+     * - 엔젤릭버스터-전체 전직
+     * - 초월자-전체 전직
+     * - 초월자-제로
+     * - 은월-전체 전직
+     * - 프렌즈 월드-전체 전직
+     * - 프렌즈 월드-키네시스
+     * - 카데나-전체 전직
+     * - 일리움-전체 전직
+     * - 아크-전체 전직
+     * - 호영-전체 전직
+     * - 아델-전체 전직
+     * - 카인-전체 전직
+     * - 라라-전체 전직
+     * - 칼리-전체 전직
+     */
+    characterClass?: string;
+    /**
+     * 캐릭터 식별자
+     */
+    ocid?: string;
+    /**
+     * 페이지 번호
+     */
+    page?: number;
+};
+type UnionRankingApiFilterOptions = {
+    /**
+     * 월드 명
+     *
+     * - 스카니아
+     * - 베라
+     * - 루나
+     * - 제니스
+     * - 크로아
+     * - 유니온
+     * - 엘리시움
+     * - 이노시스
+     * - 레드
+     * - 오로라
+     * - 아케인
+     * - 노바
+     * - 리부트
+     * - 리부트2
+     * - 버닝
+     * - 버닝2
+     * - 버닝3
+     */
+    worldName?: string;
+    /**
+     * 캐릭터 식별자
+     */
+    ocid?: string;
+    /**
+     * 페이지 번호
+     */
+    page?: number;
+};
+type GuildRankingApiFilterOptions = {
+    /**
+     * 월드 명
+     *
+     * - 스카니아
+     * - 베라
+     * - 루나
+     * - 제니스
+     * - 크로아
+     * - 유니온
+     * - 엘리시움
+     * - 이노시스
+     * - 레드
+     * - 오로라
+     * - 아케인
+     * - 노바
+     * - 리부트
+     * - 리부트2
+     * - 버닝
+     * - 버닝2
+     * - 버닝3
+     */
+    worldName?: string;
+    /**
+     * 랭킹 타입 (0:주간 명성치, 1:플래그 레이스, 2:지하 수로)
+     */
+    rankingType: number;
+    /**
+     * 캐릭터 식별자
+     */
+    ocid?: string;
+    /**
+     * 페이지 번호
+     */
+    page?: number;
+};
+type DojangRankingApiFilterOptions = {
+    /**
+     * 월드 명
+     *
+     * - 스카니아
+     * - 베라
+     * - 루나
+     * - 제니스
+     * - 크로아
+     * - 유니온
+     * - 엘리시움
+     * - 이노시스
+     * - 레드
+     * - 오로라
+     * - 아케인
+     * - 노바
+     * - 리부트
+     * - 리부트2
+     * - 버닝
+     * - 버닝2
+     * - 버닝3
+     */
+    worldName?: string;
+    /**
+     * 구간 (0:일반, 1:통달)
+     */
+    difficulty: number;
+    /**
+     * 직업 및 전직
+     * - 초보자-전체 전직
+     * - 전사-전체 전직
+     * - 전사-검사
+     * - 전사-파이터
+     * - 전사-페이지
+     * - 전사-스피어맨
+     * - 전사-크루세이더
+     * - 전사-나이트
+     * - 전사-버서커
+     * - 전사-히어로
+     * - 전사-팔라딘
+     * - 전사-다크나이트
+     * - 마법사-전체 전직
+     * - 마법사-매지션
+     * - 마법사-위자드(불,독)
+     * - 마법사-위자드(썬,콜)
+     * - 마법사-클레릭
+     * - 마법사-메이지(불,독)
+     * - 마법사-메이지(썬,콜)
+     * - 마법사-프리스트
+     * - 마법사-아크메이지(불,독)
+     * - 마법사-아크메이지(썬,콜)
+     * - 마법사-비숍
+     * - 궁수-전체 전직
+     * - 궁수-아처
+     * - 궁수-헌터
+     * - 궁수-사수
+     * - 궁수-레인저
+     * - 궁수-저격수
+     * - 궁수-보우마스터
+     * - 궁수-신궁
+     * - 궁수-아처(패스파인더)
+     * - 궁수-에인션트아처
+     * - 궁수-체이서
+     * - 궁수-패스파인더
+     * - 도적-전체 전직
+     * - 도적-로그
+     * - 도적-어쌔신
+     * - 도적-시프
+     * - 도적-허밋
+     * - 도적-시프마스터
+     * - 도적-나이트로드
+     * - 도적-섀도어
+     * - 도적-세미듀어러
+     * - 도적-듀어러
+     * - 도적-듀얼마스터
+     * - 도적-슬래셔
+     * - 도적-듀얼블레이더
+     * - 해적-전체 전직
+     * - 해적-해적
+     * - 해적-인파이터
+     * - 해적-건슬링거
+     * - 해적-캐논슈터
+     * - 해적-버커니어
+     * - 해적-발키리
+     * - 해적-캐논블래스터
+     * - 해적-바이퍼
+     * - 해적-캡틴
+     * - 해적-캐논마스터
+     * - 기사단-전체 전직
+     * - 기사단-노블레스
+     * - 기사단-소울마스터
+     * - 기사단-플레임위자드
+     * - 기사단-윈드브레이커
+     * - 기사단-나이트워커
+     * - 기사단-스트라이커
+     * - 기사단-미하일
+     * - 아란-전체 전직
+     * - 에반-전체 전직
+     * - 레지스탕스-전체 전직
+     * - 레지스탕스-시티즌
+     * - 레지스탕스-배틀메이지
+     * - 레지스탕스-와일드헌터
+     * - 레지스탕스-메카닉
+     * - 레지스탕스-데몬슬레이어
+     * - 레지스탕스-데몬어벤져
+     * - 레지스탕스-제논
+     * - 레지스탕스-블래스터
+     * - 메르세데스-전체 전직
+     * - 팬텀-전체 전직
+     * - 루미너스-전체 전직
+     * - 카이저-전체 전직
+     * - 엔젤릭버스터-전체 전직
+     * - 초월자-전체 전직
+     * - 초월자-제로
+     * - 은월-전체 전직
+     * - 프렌즈 월드-전체 전직
+     * - 프렌즈 월드-키네시스
+     * - 카데나-전체 전직
+     * - 일리움-전체 전직
+     * - 아크-전체 전직
+     * - 호영-전체 전직
+     * - 아델-전체 전직
+     * - 카인-전체 전직
+     * - 라라-전체 전직
+     * - 칼리-전체 전직
+     */
+    characterClass?: string;
+    /**
+     * 캐릭터 식별자
+     */
+    ocid?: string;
+    /**
+     * 페이지 번호
+     */
+    page?: number;
+};
+type TheSeedRankingApiFilterOptions = {
+    /**
+     * 월드 명
+     *
+     * - 스카니아
+     * - 베라
+     * - 루나
+     * - 제니스
+     * - 크로아
+     * - 유니온
+     * - 엘리시움
+     * - 이노시스
+     * - 레드
+     * - 오로라
+     * - 아케인
+     * - 노바
+     * - 리부트
+     * - 리부트2
+     * - 버닝
+     * - 버닝2
+     * - 버닝3
+     */
+    worldName?: string;
+    /**
+     * 캐릭터 식별자
+     */
+    ocid?: string;
+    /**
+     * 페이지 번호
+     */
+    page?: number;
+};
+type AchievementRankingApiFilterOptions = {
+    /**
+     * 캐릭터 식별자
+     */
+    ocid?: string;
+    /**
+     * 페이지 번호
+     */
+    page?: number;
+};
 type DateOptions = {
     year: number;
     month: number;
     day: number;
 };
-export { MapleStoryApi };
+type MapleStoryErrorBody = {
+    error: {
+        name: string;
+        message: string;
+    };
+};
+export { MapleStoryApi, MapleStoryErrorBody };