maplestory-openapi 2.13.0 → 3.0.0

package/types/maplestory/api/{response/notice/eventNoticeDetailDtoBody.d.ts → kms/response/notice/eventNoticeDetailBody.d.ts}

@@ -1,4 +1,4 @@
-type EventNoticeDetailDtoBody = {
+export type EventNoticeDetailBody = {
     title: string;
     url: string;
     contents: string;
@@ -6,4 +6,3 @@ type EventNoticeDetailDtoBody = {
     date_event_start: string;
     date_event_end: string;
 };
-export type { EventNoticeDetailDtoBody };

package/types/maplestory/api/kms/response/notice/eventNoticeListBody.d.ts

@@ -0,0 +1,11 @@
+export type EventNoticeListBody = {
+    event_notice: EventNoticeListItemBody[];
+};
+export type EventNoticeListItemBody = {
+    title: string;
+    url: string;
+    notice_id: number;
+    date: string;
+    date_event_start: string;
+    date_event_end: string;
+};

package/types/maplestory/api/{response/notice/noticeDetailDtoBody.d.ts → kms/response/notice/noticeDetailBody.d.ts}

@@ -1,7 +1,6 @@
-type NoticeDetailDtoBody = {
+export type NoticeDetailBody = {
     title: string;
     url: string;
     contents: string;
     date: string;
 };
-export type { NoticeDetailDtoBody };

package/types/maplestory/api/kms/response/notice/noticeListBody.d.ts

@@ -0,0 +1,9 @@
+export type NoticeListBody = {
+    notice: NoticeListItemBody[];
+};
+export type NoticeListItemBody = {
+    title: string;
+    url: string;
+    notice_id: number;
+    date: string;
+};

package/types/maplestory/api/{response/notice/updateNoticeDetailDtoBody.d.ts → kms/response/notice/updateNoticeDetailBody.d.ts}

@@ -1,7 +1,6 @@
-type UpdateNoticeDetailDtoBody = {
+export type UpdateNoticeDetailBody = {
     title: string;
     url: string;
     contents: string;
     date: string;
 };
-export type { UpdateNoticeDetailDtoBody };

package/types/maplestory/api/kms/response/notice/updateNoticeListBody.d.ts

@@ -0,0 +1,9 @@
+export type UpdateNoticeListBody = {
+    update_notice: UpdateNoticeListItemBody[];
+};
+export type UpdateNoticeListItemBody = {
+    title: string;
+    url: string;
+    notice_id: number;
+    date: string;
+};

package/types/maplestory/api/kms/response/ranking/achievementRankingBody.d.ts

@@ -0,0 +1,12 @@
+import { RankingResponseBody } from './rankingResponseBody';
+export type AchievementRankingBody = {
+    date: string;
+    ranking: number;
+    character_name: string;
+    world_name: string;
+    class_name: string;
+    sub_class_name: string;
+    trophy_grade: string;
+    trophy_score: number;
+};
+export type AchievementRankingResponseBody = RankingResponseBody<AchievementRankingBody>;

package/types/maplestory/api/kms/response/ranking/dojangRankingBody.d.ts

@@ -0,0 +1,13 @@
+import { RankingResponseBody } from './rankingResponseBody';
+export type DojangRankingBody = {
+    date: string;
+    ranking: number;
+    character_name: string;
+    world_name: string;
+    class_name: string;
+    sub_class_name: string;
+    character_level: number;
+    dojang_floor: number;
+    dojang_time_record: number;
+};
+export type DojangRankingResponseBody = RankingResponseBody<DojangRankingBody>;

package/types/maplestory/api/kms/response/ranking/guildRankingBody.d.ts

@@ -0,0 +1,12 @@
+import { RankingResponseBody } from './rankingResponseBody';
+export type GuildRankingBody = {
+    date: string;
+    ranking: number;
+    guild_name: string;
+    world_name: string;
+    guild_level: number;
+    guild_master_name: string;
+    guild_mark: string;
+    guild_point: number;
+};
+export type GuildRankingResponseBody = RankingResponseBody<GuildRankingBody>;

package/types/maplestory/api/{response/ranking/overallRankingResponseDtoBody.d.ts → kms/response/ranking/overallRankingBody.d.ts}

@@ -1,6 +1,5 @@
-import { RankingResponseDtoBody } from './rankingResponseDtoBody';
-type OverallRankingResponseDtoBody = RankingResponseDtoBody<OverallRankingDtoBody>;
-type OverallRankingDtoBody = {
+import { RankingResponseBody } from './rankingResponseBody';
+export type OverallRankingBody = {
     date: string;
     ranking: number;
     character_name: string;
@@ -12,4 +11,4 @@ type OverallRankingDtoBody = {
     character_popularity: number;
     character_guildname: string | null;
 };
-export type { OverallRankingResponseDtoBody, OverallRankingDtoBody };
+export type OverallRankingResponseBody = RankingResponseBody<OverallRankingBody>;

package/types/maplestory/api/kms/response/ranking/rankingResponseBody.d.ts

@@ -0,0 +1,6 @@
+export type RankingResponseBody<Ranking extends {
+    date: string;
+    ranking: number;
+}> = {
+    ranking: Ranking[];
+};

package/types/maplestory/api/kms/response/ranking/theSeedRankingBody.d.ts

@@ -0,0 +1,13 @@
+import { RankingResponseBody } from './rankingResponseBody';
+export type TheSeedRankingBody = {
+    date: string;
+    ranking: number;
+    character_name: string;
+    world_name: string;
+    class_name: string;
+    sub_class_name: string;
+    character_level: number;
+    theseed_floor: number;
+    theseed_time_record: number;
+};
+export type TheSeedRankingResponseBody = RankingResponseBody<TheSeedRankingBody>;

package/types/maplestory/api/kms/response/ranking/unionRankingBody.d.ts

@@ -0,0 +1,12 @@
+import { RankingResponseBody } from './rankingResponseBody';
+export type UnionRankingBody = {
+    date: string;
+    ranking: number;
+    character_name: string;
+    world_name: string;
+    class_name: string;
+    sub_class_name: string;
+    union_level: number;
+    union_power: number;
+};
+export type UnionRankingResponseBody = RankingResponseBody<UnionRankingBody>;

package/types/maplestory/api/kms/response/union/unionArtifactBody.d.ts

@@ -0,0 +1,19 @@
+export type UnionArtifactBody = {
+    date: string | null;
+    union_artifact_effect: UnionArtifactEffectBody[];
+    union_artifact_crystal: UnionArtifactCrystalBody[];
+    union_artifact_remain_ap: number | null;
+};
+export type UnionArtifactEffectBody = {
+    name: string;
+    level: number;
+};
+export type UnionArtifactCrystalBody = {
+    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;
+};

package/types/maplestory/api/{response/union/unionDtoBody.d.ts → kms/response/union/unionBody.d.ts}

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

package/types/maplestory/api/kms/response/union/unionChampionBody.d.ts

@@ -0,0 +1,15 @@
+export type UnionChampionBody = {
+    date: string;
+    union_champion: UnionChampionInfoBody[];
+    champion_badge_total_info: UnionChampionBadgeInfoBody[];
+};
+export type UnionChampionInfoBody = {
+    champion_name: string;
+    champion_slot: number;
+    champion_grade: string;
+    champion_class: string;
+    champion_badge_info: UnionChampionBadgeInfoBody[];
+};
+export type UnionChampionBadgeInfoBody = {
+    stat: string;
+};

package/types/maplestory/api/kms/response/union/unionRaiderBody.d.ts

@@ -0,0 +1,38 @@
+export type UnionRaiderBody = {
+    date: string | null;
+    union_raider_stat: string[];
+    union_occupied_stat: string[];
+    union_inner_stat: UnionRaiderInnerStatBody[];
+    union_block: UnionRaiderBlockBody[];
+    use_preset_no: number;
+    union_raider_preset_1: UnionRaiderPresetBody | null;
+    union_raider_preset_2: UnionRaiderPresetBody | null;
+    union_raider_preset_3: UnionRaiderPresetBody | null;
+    union_raider_preset_4: UnionRaiderPresetBody | null;
+    union_raider_preset_5: UnionRaiderPresetBody | null;
+};
+export type UnionRaiderInnerStatBody = {
+    stat_field_id: string;
+    stat_field_effect: string;
+};
+export type UnionRaiderBlockBody = {
+    block_type: string;
+    block_class: string;
+    block_level: string;
+    block_control_point: UnionRaiderBlockControlPointBody;
+    block_position: UnionRaiderBlockPositionBody[];
+};
+export type UnionRaiderBlockControlPointBody = {
+    x: number;
+    y: number;
+};
+export type UnionRaiderBlockPositionBody = {
+    x: number;
+    y: number;
+};
+export type UnionRaiderPresetBody = {
+    union_raider_stat: string[];
+    union_occupied_stat: string[];
+    union_inner_stat: UnionRaiderInnerStatBody[];
+    union_block: UnionRaiderBlockBody[];
+};

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

@@ -0,0 +1,12 @@
+import * as base from '../../../common/dto/character/character';
+import { CharacterBody } from '../../response/character/characterBody';
+/**
+ * Character identifier information
+ */
+export declare class CharacterDto extends base.CharacterDto {
+    /**
+     * Character identifier
+     */
+    ocid: string;
+    constructor(obj: CharacterBody);
+}

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

@@ -0,0 +1,72 @@
+import * as base from '../../../common/dto/character/characterAbility';
+import { CharacterAbilityBody, CharacterAbilityInfoBody, CharacterAbilityPresetBody } from '../../response/character/characterAbilityBody';
+/**
+ * Character ability information
+ */
+export declare class CharacterAbilityDto extends base.CharacterAbilityDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Ability grade
+     */
+    abilityGrade: string | null;
+    /**
+     * Ability information
+     */
+    abilityInfo: CharacterAbilityInfoDto[];
+    /**
+     * Owned Honor EXP
+     */
+    remainFame: number | null;
+    /**
+     * Active ability preset number
+     */
+    presetNo: number | null;
+    /**
+     * Complete information for Ability Preset 1
+     */
+    abilityPreset1: CharacterAbilityPresetDto | null;
+    /**
+     * Complete information for Ability Preset 2
+     */
+    abilityPreset2: CharacterAbilityPresetDto | null;
+    /**
+     * Complete information for Ability Preset 3
+     */
+    abilityPreset3: CharacterAbilityPresetDto | null;
+    constructor(obj: CharacterAbilityBody);
+}
+/**
+ * Information for Ability Preset
+ */
+export declare class CharacterAbilityInfoDto extends base.CharacterAbilityInfoDto {
+    /**
+     * Ability number
+     */
+    abilityNo: string;
+    /**
+     * Ability grade
+     */
+    abilityGrade: string;
+    /**
+     * Ability option and value
+     */
+    abilityValue: string;
+    constructor(obj: CharacterAbilityInfoBody);
+}
+/**
+ * Character ability preset information
+ */
+export declare class CharacterAbilityPresetDto extends base.CharacterAbilityPresetDto {
+    /**
+     * Ability grade for Preset
+     */
+    abilityPresetGrade: string;
+    /**
+     * Information for Ability Preset
+     */
+    abilityInfo: CharacterAbilityInfoDto[];
+    constructor(obj: CharacterAbilityPresetBody);
+}

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

@@ -0,0 +1,295 @@
+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;
+    constructor(obj: CharacterAndroidCashItemEquipmentBody);
+}