maplestory-openapi 2.13.1 → 3.0.0

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

@@ -0,0 +1,844 @@
+import * as base from '../../../common/dto/character/characterItemEquipment';
+import { CharacterItemEquipmentAddOptionBody, CharacterItemEquipmentBaseOptionBody, CharacterItemEquipmentBody, CharacterItemEquipmentDragonInfoBody, CharacterItemEquipmentEtcOptionBody, CharacterItemEquipmentExceptionalOptionBody, CharacterItemEquipmentInfoBody, CharacterItemEquipmentMechanicInfoBody, CharacterItemEquipmentStarforceOptionBody, CharacterItemEquipmentTitleBody, CharacterItemEquipmentTotalOptionBody } from '../../response/character/characterItemEquipmentBody';
+/**
+ * Character equipped equipment information
+ */
+export declare class CharacterItemEquipmentDto extends base.CharacterItemEquipmentDto {
+    /**
+     * Reference date for query (SGT, daily data with hours and minutes set to 0)
+     */
+    date: Date | null;
+    /**
+     * Character gender
+     */
+    characterGender: string | null;
+    /**
+     * Character job
+     */
+    characterClass: string | null;
+    /**
+     * Active equipment preset number
+     */
+    presetNo: number | null;
+    /**
+     * Equipment information
+     */
+    itemEquipment: CharacterItemEquipmentInfoDto[];
+    /**
+     * Equipment information for Preset 1
+     */
+    itemEquipmentPreset1: CharacterItemEquipmentInfoDto[];
+    /**
+     * Equipment information for Preset 2
+     */
+    itemEquipmentPreset2: CharacterItemEquipmentInfoDto[];
+    /**
+     * Equipment information for Preset 3
+     */
+    itemEquipmentPreset3: CharacterItemEquipmentInfoDto[];
+    /**
+     * Title information
+     */
+    title: CharacterItemEquipmentTitleDto | null;
+    /**
+     * Evan Dragon equipment information (response provided if the character is Evan)
+     */
+    dragonEquipment: CharacterItemEquipmentDragonInfoDto[];
+    /**
+     * Mechanic equipment information (response provided if the character is a Mechanic)
+     */
+    mechanicEquipment: CharacterItemEquipmentMechanicInfoDto[];
+    constructor(obj: CharacterItemEquipmentBody);
+}
+/**
+ * Title information
+ */
+export declare class CharacterItemEquipmentTitleDto extends base.CharacterItemEquipmentTitleDto {
+    /**
+     * Title name
+     */
+    titleName: string | null;
+    /**
+     * Title icon
+     */
+    titleIcon: string | null;
+    /**
+     * Title description
+     */
+    titleDescription: string | null;
+    /**
+     * Title validity period (SGT)
+     */
+    dateExpire: Date | null;
+    /**
+     * Whether the title is expired
+     */
+    isExpired: boolean | null;
+    /**
+     * Title option validity period (expired:expired, null unlimited) (SGT)
+     */
+    dateOptionExpire: Date | null;
+    /**
+     * Whether the title option is expired
+     */
+    isOptionExpired: boolean | null;
+    constructor(obj: CharacterItemEquipmentTitleBody);
+}
+/**
+ * Additional equipment options
+ */
+export declare class CharacterItemEquipmentAddOptionDto extends base.CharacterItemEquipmentAddOptionDto {
+    /**
+     * STR
+     */
+    str: string;
+    /**
+     * DEX
+     */
+    dex: string;
+    /**
+     * INT
+     */
+    int: string;
+    /**
+     * LUK
+     */
+    luk: string;
+    /**
+     * Max HP
+     */
+    maxHp: string;
+    /**
+     * Max MP
+     */
+    maxMp: string;
+    /**
+     * Attack Power
+     */
+    attackPower: string;
+    /**
+     * Magic ATT
+     */
+    magicPower: string;
+    /**
+     * Defense
+     */
+    armor: string;
+    /**
+     * Speed
+     */
+    speed: string;
+    /**
+     * Jump
+     */
+    jump: string;
+    /**
+     * Boss Damage (%)
+     */
+    bossDamage: string;
+    /**
+     * Damage (%)
+     */
+    damage: string;
+    /**
+     * All Stats (%)
+     */
+    allStat: string;
+    /**
+     * Equipment level decrease
+     */
+    equipmentLevelDecrease: number;
+    constructor(obj: CharacterItemEquipmentAddOptionBody);
+}
+/**
+ * Basic equipment option information
+ */
+export declare class CharacterItemEquipmentBaseOptionDto extends base.CharacterItemEquipmentBaseOptionDto {
+    /**
+     * STR
+     */
+    str: string;
+    /**
+     * DEX
+     */
+    dex: string;
+    /**
+     * INT
+     */
+    int: string;
+    /**
+     * LUK
+     */
+    luk: string;
+    /**
+     * Max HP
+     */
+    maxHp: string;
+    /**
+     * Max MP
+     */
+    maxMp: string;
+    /**
+     * Attack Power
+     */
+    attackPower: string;
+    /**
+     * Magic ATT
+     */
+    magicPower: string;
+    /**
+     * Defense
+     */
+    armor: string;
+    /**
+     * Speed
+     */
+    speed: string;
+    /**
+     * Jump
+     */
+    jump: string;
+    /**
+     * Boss Damage (%)
+     */
+    bossDamage: string;
+    /**
+     * Ignore Enemy Defense (%)
+     */
+    ignoreMonsterArmor: string;
+    /**
+     * All Stats (%)
+     */
+    allStat: string;
+    /**
+     * Max HP (%)
+     */
+    maxHpRate: string;
+    /**
+     * Max MP (%)
+     */
+    maxMpRate: string;
+    /**
+     * Basic equipment level
+     */
+    baseEquipmentLevel: number;
+    constructor(obj: CharacterItemEquipmentBaseOptionBody);
+}
+/**
+ * Miscellaneous equipment option information
+ */
+export declare class CharacterItemEquipmentEtcOptionDto extends base.CharacterItemEquipmentEtcOptionDto {
+    /**
+     * STR
+     */
+    str: string;
+    /**
+     * DEX
+     */
+    dex: string;
+    /**
+     * INT
+     */
+    int: string;
+    /**
+     * LUK
+     */
+    luk: string;
+    /**
+     * Max HP
+     */
+    maxHp: string;
+    /**
+     * Max MP
+     */
+    maxMp: string;
+    /**
+     * Attack Power
+     */
+    attackPower: string;
+    /**
+     * Magic ATT
+     */
+    magicPower: string;
+    /**
+     * Defense
+     */
+    armor: string;
+    /**
+     * Speed
+     */
+    speed: string;
+    /**
+     * Jump
+     */
+    jump: string;
+    constructor(obj: CharacterItemEquipmentEtcOptionBody);
+}
+/**
+ * Exceptional equipment option information
+ */
+export declare class CharacterItemEquipmentExceptionalOptionDto extends base.CharacterItemEquipmentExceptionalOptionDto {
+    /**
+     * STR
+     */
+    str: string;
+    /**
+     * DEX
+     */
+    dex: string;
+    /**
+     * INT
+     */
+    int: string;
+    /**
+     * LUK
+     */
+    luk: string;
+    /**
+     * Max HP
+     */
+    maxHp: string;
+    /**
+     * Max MP
+     */
+    maxMp: string;
+    /**
+     * Attack Power
+     */
+    attackPower: string;
+    /**
+     * Magic ATT
+     */
+    magicPower: string;
+    /**
+     * Number of exceptional boost applications
+     */
+    exceptionalUpgrade: number;
+    constructor(obj: CharacterItemEquipmentExceptionalOptionBody);
+}
+/**
+ * Equipment Star Force option information
+ */
+export declare class CharacterItemEquipmentStarforceOptionDto extends base.CharacterItemEquipmentStarforceOptionDto {
+    /**
+     * STR
+     */
+    str: string;
+    /**
+     * DEX
+     */
+    dex: string;
+    /**
+     * INT
+     */
+    int: string;
+    /**
+     * LUK
+     */
+    luk: string;
+    /**
+     * Max HP
+     */
+    maxHp: string;
+    /**
+     * Max MP
+     */
+    maxMp: string;
+    /**
+     * Attack Power
+     */
+    attackPower: string;
+    /**
+     * Magic ATT
+     */
+    magicPower: string;
+    /**
+     * Defense
+     */
+    armor: string;
+    /**
+     * Speed
+     */
+    speed: string;
+    /**
+     * Jump
+     */
+    jump: string;
+    constructor(obj: CharacterItemEquipmentStarforceOptionBody);
+}
+/**
+ * Final equipment option information
+ */
+export declare class CharacterItemEquipmentTotalOptionDto extends base.CharacterItemEquipmentTotalOptionDto {
+    /**
+     * STR
+     */
+    str: string;
+    /**
+     * DEX
+     */
+    dex: string;
+    /**
+     * INT
+     */
+    int: string;
+    /**
+     * LUK
+     */
+    luk: string;
+    /**
+     * Max HP
+     */
+    maxHp: string;
+    /**
+     * Max MP
+     */
+    maxMp: string;
+    /**
+     * Attack Power
+     */
+    attackPower: string;
+    /**
+     * Magic ATT
+     */
+    magicPower: string;
+    /**
+     * Defense
+     */
+    armor: string;
+    /**
+     * Speed
+     */
+    speed: string;
+    /**
+     * Jump
+     */
+    jump: string;
+    /**
+     * Boss Damage (%)
+     */
+    bossDamage: string;
+    /**
+     * Ignore Enemy Defense (%)
+     */
+    ignoreMonsterArmor: string;
+    /**
+     * All Stats (%)
+     */
+    allStat: string;
+    /**
+     * Damage (%)
+     */
+    damage: string;
+    /**
+     * Equipment level decreases
+     */
+    equipmentLevelDecrease: number;
+    /**
+     * Max HP (%)
+     */
+    maxHpRate: string;
+    /**
+     * Max MP (%)
+     */
+    maxMpRate: string;
+    constructor(obj: CharacterItemEquipmentTotalOptionBody);
+}
+/**
+ * Evan Dragon equipment information
+ */
+export declare class CharacterItemEquipmentDragonInfoDto extends base.CharacterItemEquipmentDragonInfoDto {
+    /**
+     * Equipment part name
+     */
+    itemEquipmentPart: string;
+    /**
+     * Equipment slot position
+     */
+    itemEquipmentSlot: string;
+    /**
+     * Equipment name
+     */
+    itemName: string;
+    /**
+     * Equipment icon
+     */
+    itemIcon: string;
+    /**
+     * Equipment description
+     */
+    itemDescription: string | null;
+    /**
+     * Equipment type
+     */
+    itemShapeName: string;
+    /**
+     * Equipment type icon
+     */
+    itemShapeIcon: string;
+    /**
+     * Gender-specific equipment
+     */
+    itemGender: string | null;
+    /**
+     * Final equipment option information
+     */
+    itemTotalOption: CharacterItemEquipmentTotalOptionDto;
+    /**
+     * Basic equipment option information
+     */
+    itemBaseOption: CharacterItemEquipmentBaseOptionDto;
+    /**
+     * Equipment level increases
+     */
+    equipmentLevelIncrease: number;
+    /**
+     * Exceptional equipment option information
+     */
+    itemExceptionalOption: CharacterItemEquipmentExceptionalOptionDto;
+    /**
+     * Additional equipment options
+     */
+    itemAddOption: CharacterItemEquipmentAddOptionDto;
+    /**
+     * Growth EXP
+     */
+    growthExp: number;
+    /**
+     * Growth level
+     */
+    growthLevel: number;
+    /**
+     * Number of upgrades
+     */
+    scrollUpgrade: string;
+    /**
+     * Number of scissors usage available (Untradable, 255 for equipment without scissors usage count)
+     */
+    cuttableCount: string;
+    /**
+     * Golden Hammer refinement applied (true:applied, false:not applied)
+     */
+    goldenHammerFlag: string;
+    /**
+     * Number of restoration attempts available
+     */
+    scrollResilienceCount: string;
+    /**
+     * Number of upgrades available
+     */
+    scrollUpgradeableCount: string;
+    /**
+     * Soul name
+     */
+    soulName: string | null;
+    /**
+     * Soul option
+     */
+    soulOption: string | null;
+    /**
+     * Miscellaneous equipment option information
+     */
+    itemEtcOption: CharacterItemEquipmentEtcOptionDto;
+    /**
+     * Enhancement level
+     */
+    starforce: string;
+    /**
+     * Usage status of Miraculous Equip Enhancement Scroll (true:used, false:not used)
+     */
+    starforceScrollFlag: string;
+    /**
+     * Equipment Star Force option information
+     */
+    itemStarforceOption: CharacterItemEquipmentStarforceOptionDto;
+    /**
+     * Special Skill Ring
+     */
+    specialRingLevel: number;
+    /**
+     * Equipment expiration date (SGT)
+     */
+    dateExpire: Date | null;
+    /**
+     * Whether the equipment is expired
+     */
+    isExpired: boolean | null;
+    constructor(obj: CharacterItemEquipmentDragonInfoBody);
+}
+/**
+ * Mechanic equipment information
+ */
+export declare class CharacterItemEquipmentMechanicInfoDto extends base.CharacterItemEquipmentMechanicInfoDto {
+    /**
+     * Equipment part name
+     */
+    itemEquipmentPart: string;
+    /**
+     * Equipment slot position
+     */
+    itemEquipmentSlot: string;
+    /**
+     * Equipment name
+     */
+    itemName: string;
+    /**
+     * Equipment icon
+     */
+    itemIcon: string;
+    /**
+     * Equipment description
+     */
+    itemDescription: string | null;
+    /**
+     * Equipment type
+     */
+    itemShapeName: string;
+    /**
+     * Equipment type icon
+     */
+    itemShapeIcon: string;
+    /**
+     * Gender-specific equipment
+     */
+    itemGender: string | null;
+    /**
+     * Final equipment option information
+     */
+    itemTotalOption: CharacterItemEquipmentTotalOptionDto;
+    /**
+     * Basic equipment option information
+     */
+    itemBaseOption: CharacterItemEquipmentBaseOptionDto;
+    /**
+     * Equipment level increases
+     */
+    equipmentLevelIncrease: number;
+    /**
+     * Exceptional equipment option information
+     */
+    itemExceptionalOption: CharacterItemEquipmentExceptionalOptionDto;
+    /**
+     * Additional equipment options
+     */
+    itemAddOption: CharacterItemEquipmentAddOptionDto;
+    /**
+     * Growth EXP
+     */
+    growthExp: number;
+    /**
+     * Growth level
+     */
+    growthLevel: number;
+    /**
+     * Number of upgrades
+     */
+    scrollUpgrade: string;
+    /**
+     * Number of scissors usage available (Untradable, 255 for equipment without scissors usage count)
+     */
+    cuttableCount: string;
+    /**
+     * Golden Hammer refinement applied (true:applied, false:not applied)
+     */
+    goldenHammerFlag: string;
+    /**
+     * Number of restoration attempts available
+     */
+    scrollResilienceCount: string;
+    /**
+     * Number of upgrades available
+     */
+    scrollUpgradeableCount: string;
+    /**
+     * Soul name
+     */
+    soulName: string | null;
+    /**
+     * Soul option
+     */
+    soulOption: string | null;
+    /**
+     * Miscellaneous equipment option information
+     */
+    itemEtcOption: CharacterItemEquipmentEtcOptionDto;
+    /**
+     * Enhancement level
+     */
+    starforce: string;
+    /**
+     * Usage status of Miraculous Equip Enhancement Scroll (true:used, false:not used)
+     */
+    starforceScrollFlag: string;
+    /**
+     * Equipment Star Force option information
+     */
+    itemStarforceOption: CharacterItemEquipmentStarforceOptionDto;
+    /**
+     * Special Skill Ring
+     */
+    specialRingLevel: number;
+    /**
+     * Equipment expiration date (SGT)
+     */
+    dateExpire: Date | null;
+    /**
+     * Whether the equipment is expired
+     */
+    isExpired: boolean | null;
+    constructor(obj: CharacterItemEquipmentMechanicInfoBody);
+}
+/**
+ * Equipment information
+ */
+export declare class CharacterItemEquipmentInfoDto extends base.CharacterItemEquipmentInfoDto {
+    /**
+     * Equipment part name
+     */
+    itemEquipmentPart: string;
+    /**
+     * Equipment slot position
+     */
+    itemEquipmentSlot: string;
+    /**
+     * Equipment name
+     */
+    itemName: string;
+    /**
+     * Equipment icon
+     */
+    itemIcon: string;
+    /**
+     * Equipment description
+     */
+    itemDescription: string | null;
+    /**
+     * Equipment type
+     */
+    itemShapeName: string;
+    /**
+     * Equipment type icon
+     */
+    itemShapeIcon: string;
+    /**
+     * Gender-specific equipment
+     */
+    itemGender: string | null;
+    /**
+     * Final equipment option information
+     */
+    itemTotalOption: CharacterItemEquipmentTotalOptionDto;
+    /**
+     * Basic equipment option information
+     */
+    itemBaseOption: CharacterItemEquipmentBaseOptionDto;
+    /**
+     * Potential grade
+     */
+    potentialOptionGrade: string | null;
+    /**
+     * Additional potential grade
+     */
+    additionalPotentialOptionGrade: string | null;
+    /**
+     * First Potential option
+     */
+    potentialOption1: string | null;
+    /**
+     * Second Potential option
+     */
+    potentialOption2: string | null;
+    /**
+     * Third Potential option
+     */
+    potentialOption3: string | null;
+    /**
+     * First additional Potential option
+     */
+    additionalPotentialOption1: string | null;
+    /**
+     * Second additional Potential option
+     */
+    additionalPotentialOption2: string | null;
+    /**
+     * Third additional Potential option
+     */
+    additionalPotentialOption3: string | null;
+    /**
+     * Equipment level increase
+     */
+    equipmentLevelIncrease: number;
+    /**
+     * Exceptional equipment option information
+     */
+    itemExceptionalOption: CharacterItemEquipmentExceptionalOptionDto;
+    /**
+     * Additional equipment options
+     */
+    itemAddOption: CharacterItemEquipmentAddOptionDto;
+    /**
+     * Growth EXP
+     */
+    growthExp: number;
+    /**
+     * Growth level
+     */
+    growthLevel: number;
+    /**
+     * Number of upgrade attempts
+     */
+    scrollUpgrade: string;
+    /**
+     * Number of scissors usage available (Untradable, 255 for equipment without scissors usage count)
+     */
+    cuttableCount: string;
+    /**
+     * Golden Hammer refinement applied (true:applied, false:not applied)
+     */
+    goldenHammerFlag: string;
+    /**
+     * Number of restoration attempts available
+     */
+    scrollResilienceCount: string;
+    /**
+     * Number of upgrades available
+     */
+    scrollUpgradeableCount: string;
+    /**
+     * Soul name
+     */
+    soulName: string | null;
+    /**
+     * Soul option
+     */
+    soulOption: string | null;
+    /**
+     * Miscellaneous equipment option information
+     */
+    itemEtcOption: CharacterItemEquipmentEtcOptionDto;
+    /**
+     * Enhancement level
+     */
+    starforce: string;
+    /**
+     * Usage status of Miraculous Equip Enhancement Scroll (true:used, false:not used)
+     */
+    starforceScrollFlag: string;
+    /**
+     * Equipment Star Force option information
+     */
+    itemStarforceOption: CharacterItemEquipmentStarforceOptionDto;
+    /**
+     * Special Skill Ring
+     */
+    specialRingLevel: number;
+    /**
+     * Equipment expiration date (SGT)
+     */
+    dateExpire: Date | null;
+    /**
+     * Whether the equipment is expired
+     */
+    isExpired: boolean | null;
+    constructor(obj: CharacterItemEquipmentInfoBody);
+}