maplestory-openapi 2.13.1 → 3.0.0

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

@@ -0,0 +1,78 @@
+import * as base from '../../../common/dto/character/characterLinkSkill';
+import { CharacterLinkSkillBody, CharacterLinkSkillInfoBody } from '../../response/character/characterLinkSkillBody';
+/**
+ * Character equipped link skill information
+ */
+export declare class CharacterLinkSkillDto extends base.CharacterLinkSkillDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Character job
+     */
+    characterClass: string | null;
+    /**
+     * Link Skill information
+     */
+    characterLinkSkill: CharacterLinkSkillInfoDto[];
+    /**
+     * Link Skill information for preset 1
+     */
+    characterLinkSkillPreset1: CharacterLinkSkillInfoDto[];
+    /**
+     * Link Skill information for preset 2
+     */
+    characterLinkSkillPreset2: CharacterLinkSkillInfoDto[];
+    /**
+     * Link Skill information for preset 3
+     */
+    characterLinkSkillPreset3: CharacterLinkSkillInfoDto[];
+    /**
+     * My Link Skill information
+     */
+    characterOwnedLinkSkill: CharacterLinkSkillInfoDto | null;
+    /**
+     * My Link Skill information for preset 1
+     */
+    characterOwnedLinkSkillPreset1: CharacterLinkSkillInfoDto | null;
+    /**
+     * My Link Skill information for preset 2
+     */
+    characterOwnedLinkSkillPreset2: CharacterLinkSkillInfoDto | null;
+    /**
+     * My Link Skill information for preset 3
+     */
+    characterOwnedLinkSkillPreset3: CharacterLinkSkillInfoDto | null;
+    constructor(obj: CharacterLinkSkillBody);
+}
+/**
+ * Character link skill information
+ */
+export declare class CharacterLinkSkillInfoDto extends base.CharacterLinkSkillInfoDto {
+    /**
+     * Skill name
+     */
+    skillName: string;
+    /**
+     * Skill description
+     */
+    skillDescription: string;
+    /**
+     * Skill level
+     */
+    skillLevel: number;
+    /**
+     * Skill effect
+     */
+    skillEffect: string;
+    /**
+     * Effect for the next skill level
+     */
+    skillEffectNext: string | null;
+    /**
+     * Skill icon
+     */
+    skillIcon: string;
+    constructor(obj: CharacterLinkSkillInfoBody);
+}

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

@@ -0,0 +1,230 @@
+import * as base from '../../../common/dto/character/characterPetEquipment';
+import { CharacterPetEquipmentAutoSkillBody, CharacterPetEquipmentBody, CharacterPetEquipmentItemBody, CharacterPetEquipmentItemOptionBody } from '../../response/character/characterPetEquipmentBody';
+/**
+ * Character equipped pet information
+ */
+export declare class CharacterPetEquipmentDto extends base.CharacterPetEquipmentDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Name of pet 1
+     */
+    pet1Name: string | null;
+    /**
+     * Nickname of pet 1
+     */
+    pet1Nickname: string | null;
+    /**
+     * Icon of pet 1
+     */
+    pet1Icon: string | null;
+    /**
+     * Description of pet 1
+     */
+    pet1Description: string | null;
+    /**
+     * Equipment information for pet 1
+     */
+    pet1Equipment: CharacterPetEquipmentItemDto | null;
+    /**
+     * Auto buff skill information for pet 1
+     */
+    pet1AutoSkill: CharacterPetEquipmentAutoSkillDto | null;
+    /**
+     * Wonder pet type of pet 1
+     */
+    pet1PetType: string | null;
+    /**
+     * Skills possessed by pet 1
+     */
+    pet1Skill: string[];
+    /**
+     * Magic time for pet 1 (SGT, data with minutes set to 0)
+     */
+    pet1DateExpire: Date | null;
+    /**
+     * Whether the magic time for pet 1 is expired
+     */
+    pet1Expired: boolean | null;
+    /**
+     * Appearance of pet 1
+     */
+    pet1Appearance: string | null;
+    /**
+     * Appearance icon of pet 1
+     */
+    pet1AppearanceIcon: string | null;
+    /**
+     * Name of pet 2
+     */
+    pet2Name: string | null;
+    /**
+     * Nickname of pet 2
+     */
+    pet2Nickname: string | null;
+    /**
+     * Icon of pet 2
+     */
+    pet2Icon: string | null;
+    /**
+     * Description of pet 2
+     */
+    pet2Description: string | null;
+    /**
+     * Equipment information for pet 2
+     */
+    pet2Equipment: CharacterPetEquipmentItemDto | null;
+    /**
+     * Auto buff skill information for pet 2
+     */
+    pet2AutoSkill: CharacterPetEquipmentAutoSkillDto | null;
+    /**
+     * Wonder pet type of pet 2
+     */
+    pet2PetType: string | null;
+    /**
+     * Skills possessed by pet 2
+     */
+    pet2Skill: string[];
+    /**
+     * Magic time for pet 2 (SGT, data with minutes set to 0)
+     */
+    pet2DateExpire: Date | null;
+    /**
+     * Whether the magic time for pet 2 is expired
+     */
+    pet2Expired: boolean | null;
+    /**
+     * Appearance of pet 2
+     */
+    pet2Appearance: string | null;
+    /**
+     * Appearance icon of pet 2
+     */
+    pet2AppearanceIcon: string | null;
+    /**
+     * Name of pet 3
+     */
+    pet3Name: string | null;
+    /**
+     * Nickname of pet 3
+     */
+    pet3Nickname: string | null;
+    /**
+     * Icon of pet 3
+     */
+    pet3Icon: string | null;
+    /**
+     * Description of pet 3
+     */
+    pet3Description: string | null;
+    /**
+     * Equipment information for pet 3
+     */
+    pet3Equipment: CharacterPetEquipmentItemDto | null;
+    /**
+     * Auto buff skill information for pet 3
+     */
+    pet3AutoSkill: CharacterPetEquipmentAutoSkillDto | null;
+    /**
+     * Wonder pet type of pet 3
+     */
+    pet3PetType: string | null;
+    /**
+     * Skills possessed by pet 3
+     */
+    pet3Skill: string[];
+    /**
+     * Magic time for pet 3 (SGT, data with minutes set to 0)
+     */
+    pet3DateExpire: Date | null;
+    /**
+     * Whether the magic time for pet 3 is expired
+     */
+    pet3Expired: boolean | null;
+    /**
+     * Appearance of pet 3
+     */
+    pet3Appearance: string | null;
+    /**
+     * Appearance icon of pet 3
+     */
+    pet3AppearanceIcon: string | null;
+    constructor(obj: CharacterPetEquipmentBody);
+}
+/**
+ * Auto buff skill information for pet
+ */
+export declare class CharacterPetEquipmentAutoSkillDto extends base.CharacterPetEquipmentAutoSkillDto {
+    /**
+     * Auto skill registered in the first slot
+     */
+    skill1: string | null;
+    /**
+     * Icon for the auto skill in the first slot
+     */
+    skill1Icon: string | null;
+    /**
+     * Auto skill registered in the second slot
+     */
+    skill2: string | null;
+    /**
+     * Icon for the auto skill in the second slot
+     */
+    skill2Icon: string | null;
+    constructor(obj: CharacterPetEquipmentAutoSkillBody);
+}
+/**
+ * Displayed pet item options
+ */
+export declare class CharacterPetEquipmentItemOptionDto extends base.CharacterPetEquipmentItemOptionDto {
+    /**
+     * Option type
+     */
+    optionType: string;
+    /**
+     * Option value
+     */
+    optionValue: string;
+    constructor(obj: CharacterPetEquipmentItemOptionBody);
+}
+/**
+ * Equipment information for pet
+ */
+export declare class CharacterPetEquipmentItemDto extends base.CharacterPetEquipmentItemDto {
+    /**
+     * Item name
+     */
+    itemName: string | null;
+    /**
+     * Item icon
+     */
+    itemIcon: string | null;
+    /**
+     * Item description
+     */
+    itemDescription: string | null;
+    /**
+     * Displayed item options
+     */
+    itemOption: CharacterPetEquipmentItemOptionDto[];
+    /**
+     * Number of upgrades
+     */
+    scrollUpgrade: number;
+    /**
+     * Number of upgrades available
+     */
+    scrollUpgradable: number;
+    /**
+     * Item appearance
+     */
+    itemShape: string | null;
+    /**
+     * Item appearance icon
+     */
+    itemShapeIcon: string | null;
+    constructor(obj: CharacterPetEquipmentItemBody);
+}

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

@@ -0,0 +1,16 @@
+import * as base from '../../../common/dto/character/characterPopularity';
+import { CharacterPopularityBody } from '../../response/character/characterPopularityBody';
+/**
+ * Character popularity information
+ */
+export declare class CharacterPopularityDto extends base.CharacterPopularityDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Character popularity
+     */
+    popularity: number;
+    constructor(obj: CharacterPopularityBody);
+}

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

@@ -0,0 +1,36 @@
+import * as base from '../../../common/dto/character/characterPropensity';
+import { CharacterPropensityBody } from '../../response/character/characterPropensityBody';
+/**
+ * Character traits information
+ */
+export declare class CharacterPropensityDto extends base.CharacterPropensityDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Ambition level
+     */
+    charismaLevel: number | null;
+    /**
+     * Empathy level
+     */
+    sensibilityLevel: number | null;
+    /**
+     * Insight level
+     */
+    insightLevel: number | null;
+    /**
+     * Willpower level
+     */
+    willingnessLevel: number | null;
+    /**
+     * Diligence level
+     */
+    handicraftLevel: number | null;
+    /**
+     * Charm level
+     */
+    charmLevel: number | null;
+    constructor(obj: CharacterPropensityBody);
+}

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

@@ -0,0 +1,66 @@
+import * as base from '../../../common/dto/character/characterSetEffect';
+import { CharacterSetEffectBody, CharacterSetEffectInfoBody, CharacterSetEffectOptionFullBody, CharacterSetEffectSetBody } from '../../response/character/characterSetEffectBody';
+/**
+ * Character information about equipped set item effects
+ */
+export declare class CharacterSetEffectDto extends base.CharacterSetEffectDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Set Item effect information
+     */
+    setEffect: CharacterSetEffectSetDto[];
+    constructor(obj: CharacterSetEffectBody);
+}
+/**
+ * Active Set Item effect information
+ */
+export declare class CharacterSetEffectInfoDto extends base.CharacterSetEffectInfoDto {
+    /**
+     * Set Item effect level (number of equipped items)
+     */
+    setCount: number;
+    /**
+     * Set Item effect
+     */
+    setOption: string;
+    constructor(obj: CharacterSetEffectInfoBody);
+}
+/**
+ * All Set Item effect information
+ */
+export declare class CharacterSetEffectOptionFullDto extends base.CharacterSetEffectOptionFullDto {
+    /**
+     * Set Item effect level (number of equipped items)
+     */
+    setCount: number;
+    /**
+     * Set Item effect
+     */
+    setOption: string;
+    constructor(obj: CharacterSetEffectOptionFullBody);
+}
+/**
+ * Set Item effect information
+ */
+export declare class CharacterSetEffectSetDto extends base.CharacterSetEffectSetDto {
+    /**
+     * Set Item effect name
+     */
+    setName: string;
+    /**
+     * Number of Set Items (including Lucky Items)
+     */
+    totalSetCount: number;
+    /**
+     * Active Set Item effect information
+     */
+    setEffectInfo: CharacterSetEffectInfoDto[];
+    /**
+     * All Set Item effect information
+     */
+    setOptionFull: CharacterSetEffectOptionFullDto[];
+    constructor(obj: CharacterSetEffectSetBody);
+}

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

@@ -0,0 +1,54 @@
+import * as base from '../../../common/dto/character/characterSkill';
+import { CharacterSkillBody, CharacterSkillInfoBody } from '../../response/character/characterSkillBody';
+/**
+ * Character skill information
+ */
+export declare class CharacterSkillDto extends base.CharacterSkillDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Character job
+     */
+    characterClass: string | null;
+    /**
+     * Job advancement tier required to acquire the skill
+     */
+    characterSkillGrade: string | null;
+    /**
+     * Skill information
+     */
+    characterSkill: CharacterSkillInfoDto[];
+    constructor(obj: CharacterSkillBody);
+}
+/**
+ * Skill information
+ */
+export declare class CharacterSkillInfoDto extends base.CharacterSkillInfoDto {
+    /**
+     * Skill name
+     */
+    skillName: string;
+    /**
+     * Skill description
+     */
+    skillDescription: string;
+    /**
+     * Skill level
+     */
+    skillLevel: number;
+    /**
+     * Effect description by skill level
+     */
+    skillEffect: string;
+    /**
+     * Effect description for the next skill level
+     */
+    skillEffectNext: string | null;
+    /**
+     * Skill icon
+     */
+    skillIcon: string;
+    constructor(obj: CharacterSkillInfoBody);
+}

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

@@ -0,0 +1,38 @@
+import * as base from '../../../common/dto/character/characterStat';
+import { CharacterFinalStatBody, CharacterStatBody } from '../../response/character/characterStatBody';
+/**
+ * Character comprehensive stats information
+ */
+export declare class CharacterStatDto extends base.CharacterStatDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Character job
+     */
+    characterClass: string | null;
+    /**
+     * Current stat information
+     */
+    finalStat: CharacterFinalStatDto[];
+    /**
+     * Remaining AP
+     */
+    remainAP: number | null;
+    constructor(obj: CharacterStatBody);
+}
+/**
+ * Current stat information
+ */
+export declare class CharacterFinalStatDto extends base.CharacterFinalStatDto {
+    /**
+     * Stat name
+     */
+    statName: string;
+    /**
+     * Stat value
+     */
+    statValue: string;
+    constructor(obj: CharacterFinalStatBody);
+}

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

@@ -0,0 +1,86 @@
+import * as base from '../../../common/dto/character/characterSymbolEquipment';
+import { CharacterSymbolEquipmentBody, CharacterSymbolEquipmentInfoBody } from '../../response/character/characterSymbolEquipmentBody';
+/**
+ * Character equipped symbol information
+ */
+export declare class CharacterSymbolEquipmentDto extends base.CharacterSymbolEquipmentDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Character job
+     */
+    characterClass: string | null;
+    /**
+     * Symbol information
+     */
+    symbol: CharacterSymbolEquipmentInfoDto[];
+    constructor(obj: CharacterSymbolEquipmentBody);
+}
+/**
+ * Symbol information
+ */
+export declare class CharacterSymbolEquipmentInfoDto extends base.CharacterSymbolEquipmentInfoDto {
+    /**
+     * Symbol name
+     */
+    symbolName: string;
+    /**
+     * Symbol icon
+     */
+    symbolIcon: string;
+    /**
+     * Symbol description
+     */
+    symbolDescription: string;
+    /**
+     * Increase in stats due to the symbol
+     */
+    symbolForce: string;
+    /**
+     * Symbol level
+     */
+    symbolLevel: number;
+    /**
+     * Increase in Strength due to the symbol
+     */
+    symbolStr: string;
+    /**
+     * Increase in Dexterity due to the symbol
+     */
+    symbolDex: string;
+    /**
+     * Increase in Intelligence due to the symbol
+     */
+    symbolInt: string;
+    /**
+     * Increase in Luck due to the symbol
+     */
+    symbolLuk: string;
+    /**
+     * Increase in HP due to the symbol
+     */
+    symbolHp: string;
+    /**
+     * Increase in item drop rate due to the symbol
+     */
+    symbolDropRate: string;
+    /**
+     * Increase in Meso acquisition rate due to the symbol
+     */
+    symbolMesoRate: string;
+    /**
+     * Increase in EXP acquisition rate due to the symbol
+     */
+    symbolExpRate: string;
+    /**
+     * Current growth points
+     */
+    symbolGrowthCount: number;
+    /**
+     * Growth points required for the next level
+     */
+    symbolRequireGrowthCount: number;
+    constructor(obj: CharacterSymbolEquipmentInfoBody);
+}

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

@@ -0,0 +1,62 @@
+import * as base from '../../../common/dto/character/characterVMatrix';
+import { CharacterVMatrixBody, CharacterVMatrixCoreEquipmentDtoBody } from '../../response/character/characterVMatrixBody';
+/**
+ * Character V Matrix information
+ */
+export declare class CharacterVMatrixDto extends base.CharacterVMatrixDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Character job
+     */
+    characterClass: string | null;
+    /**
+     * V Matrix Node information
+     */
+    characterVCoreEquipment: CharacterVMatrixCodeEquipmentDto[];
+    /**
+     * Remaining Matrix enhancement points for the character
+     */
+    characterVMatrixRemainSlotUpgradePoint: number | null;
+    constructor(obj: CharacterVMatrixBody);
+}
+/**
+ * V Matrix Node information
+ */
+export declare class CharacterVMatrixCodeEquipmentDto extends base.CharacterVMatrixCodeEquipmentDto {
+    /**
+     * Slot index
+     */
+    slotId: string;
+    /**
+     * Slot level
+     */
+    slotLevel: number;
+    /**
+     * Node name
+     */
+    vCoreName: string | null;
+    /**
+     * Node type
+     */
+    vCoreType: string | null;
+    /**
+     * Node level
+     */
+    vCoreLevel: number;
+    /**
+     * Name of the skill that corresponds to the node
+     */
+    vCoreSkill1: string;
+    /**
+     * Name of the second skill that corresponds to the node (for Boost Nodes)
+     */
+    vCoreSkill2: string | null;
+    /**
+     * Name of the third skill that corresponds to the node (for Boost Nodes)
+     */
+    vCoreSkill3: string | null;
+    constructor(obj: CharacterVMatrixCoreEquipmentDtoBody);
+}

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

@@ -0,0 +1,12 @@
+import * as base from '../../../common/dto/guild/guild';
+import { GuildBody } from '../../response/guild/guildBody';
+/**
+ * Guild identifier information
+ */
+export declare class GuildDto extends base.GuildDto {
+    /**
+     * Guild identifier
+     */
+    oguildId: string;
+    constructor(obj: GuildBody);
+}