maplestory-openapi 3.10.0 → 3.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/README.md +1 -0
  2. package/dist/cjs/_virtual/index.js_commonjs-exports2.js +2 -2
  3. package/dist/cjs/_virtual/index.js_commonjs-exports3.js +2 -2
  4. package/dist/cjs/maplestory/api/kms/dto/battlePractice/battlePracticeCharacterInfo.js +196 -0
  5. package/dist/cjs/maplestory/api/kms/dto/character/characterHexaMatrix.js +6 -1
  6. package/dist/cjs/maplestory/api/kms/dto/character/characterItemEquipment.js +92 -1
  7. package/dist/cjs/maplestory/api/kms/dto/character/characterPetEquipment.js +223 -1
  8. package/dist/cjs/maplestory/api/kms/dto/character/characterVMatrix.js +50 -1
  9. package/dist/cjs/maplestory/api/kms/dto/scheduler/schedulerCharacterState.js +177 -0
  10. package/dist/cjs/maplestory/api/kms/dto/union/unionRaider.js +35 -1
  11. package/dist/cjs/maplestory/api/kms/kms.js +10 -0
  12. package/dist/cjs/maplestory/api/kms/mapleStoryApi.js +38 -14
  13. package/dist/cjs/maplestory/api/kms/mapleStoryFriendsApi.js +1 -1
  14. package/dist/cjs/maplestory/api/msea/mapleStoryApi.js +1 -1
  15. package/dist/cjs/maplestory/api/tms/dto/character/characterFamiliar.js +156 -0
  16. package/dist/cjs/maplestory/api/tms/dto/character/characterPetEquipment.js +45 -1
  17. package/dist/cjs/maplestory/api/tms/mapleStoryApi.js +33 -1
  18. package/dist/cjs/maplestory/api/tms/tms.js +6 -0
  19. package/dist/cjs/node_modules/base64-js/index.js +1 -1
  20. package/dist/cjs/node_modules/buffer/index.js +2 -2
  21. package/dist/cjs/node_modules/ieee754/index.js +1 -1
  22. package/dist/esm/_virtual/index.js_commonjs-exports2.js +2 -2
  23. package/dist/esm/_virtual/index.js_commonjs-exports3.js +2 -2
  24. package/dist/esm/maplestory/api/kms/dto/battlePractice/battlePracticeCharacterInfo.js +196 -1
  25. package/dist/esm/maplestory/api/kms/dto/character/characterHexaMatrix.js +6 -1
  26. package/dist/esm/maplestory/api/kms/dto/character/characterItemEquipment.js +92 -2
  27. package/dist/esm/maplestory/api/kms/dto/character/characterPetEquipment.js +223 -2
  28. package/dist/esm/maplestory/api/kms/dto/character/characterVMatrix.js +50 -2
  29. package/dist/esm/maplestory/api/kms/dto/scheduler/schedulerCharacterState.js +170 -0
  30. package/dist/esm/maplestory/api/kms/dto/union/unionRaider.js +35 -2
  31. package/dist/esm/maplestory/api/kms/kms.js +6 -5
  32. package/dist/esm/maplestory/api/kms/mapleStoryApi.js +38 -14
  33. package/dist/esm/maplestory/api/kms/mapleStoryFriendsApi.js +1 -1
  34. package/dist/esm/maplestory/api/msea/mapleStoryApi.js +1 -1
  35. package/dist/esm/maplestory/api/tms/dto/character/characterFamiliar.js +149 -0
  36. package/dist/esm/maplestory/api/tms/dto/character/characterPetEquipment.js +45 -2
  37. package/dist/esm/maplestory/api/tms/mapleStoryApi.js +33 -1
  38. package/dist/esm/maplestory/api/tms/tms.js +2 -1
  39. package/dist/esm/node_modules/base64-js/index.js +2 -2
  40. package/dist/esm/node_modules/buffer/index.js +2 -2
  41. package/dist/esm/node_modules/ieee754/index.js +2 -2
  42. package/package.json +3 -3
  43. package/types/maplestory/api/kms/dto/battlePractice/battlePracticeCharacterInfo.d.ts +143 -1
  44. package/types/maplestory/api/kms/dto/character/characterHexaMatrix.d.ts +4 -0
  45. package/types/maplestory/api/kms/dto/character/characterItemEquipment.d.ts +63 -1
  46. package/types/maplestory/api/kms/dto/character/characterPetEquipment.d.ts +163 -1
  47. package/types/maplestory/api/kms/dto/character/characterVMatrix.d.ts +39 -1
  48. package/types/maplestory/api/kms/dto/scheduler/schedulerCharacterState.d.ts +137 -0
  49. package/types/maplestory/api/kms/dto/union/unionRaider.d.ts +27 -1
  50. package/types/maplestory/api/kms/index.d.ts +1 -0
  51. package/types/maplestory/api/kms/mapleStoryApi.d.ts +16 -8
  52. package/types/maplestory/api/kms/mapleStoryFriendsApi.d.ts +2 -2
  53. package/types/maplestory/api/kms/response/battlePractice/battlePracticeCharacterInfoBody.d.ts +36 -0
  54. package/types/maplestory/api/kms/response/character/characterHexaMatrixBody.d.ts +1 -0
  55. package/types/maplestory/api/kms/response/character/characterItemEquipmentBody.d.ts +15 -0
  56. package/types/maplestory/api/kms/response/character/characterPetEquipmentBody.d.ts +41 -0
  57. package/types/maplestory/api/kms/response/character/characterVMatrixBody.d.ts +11 -1
  58. package/types/maplestory/api/kms/response/scheduler/schedulerCharacterStateBody.d.ts +36 -0
  59. package/types/maplestory/api/kms/response/union/unionRaiderBody.d.ts +7 -0
  60. package/types/maplestory/api/tms/dto/character/characterFamiliar.d.ts +117 -0
  61. package/types/maplestory/api/tms/dto/character/characterPetEquipment.d.ts +35 -1
  62. package/types/maplestory/api/tms/index.d.ts +1 -0
  63. package/types/maplestory/api/tms/mapleStoryApi.d.ts +12 -0
  64. package/types/maplestory/api/tms/response/character/characterFamiliarBody.d.ts +31 -0
  65. package/types/maplestory/api/tms/response/character/characterPetEquipmentBody.d.ts +9 -0
@@ -47,6 +47,7 @@ export * from './dto/ranking/guildRanking';
47
47
  export * from './dto/ranking/overallRanking';
48
48
  export * from './dto/ranking/theSeedRanking';
49
49
  export * from './dto/ranking/unionRanking';
50
+ export * from './dto/scheduler/schedulerCharacterState';
50
51
  export * from './dto/union/union';
51
52
  export * from './dto/union/unionArtifact';
52
53
  export * from './dto/union/unionChampion';
@@ -32,6 +32,8 @@ import { CubeHistoryResponseDto } from './dto/history/cubeHistory';
32
32
  import { PotentialHistoryResponseDto } from './dto/history/potentialHistory';
33
33
  import { StarforceHistoryResponseDto } from './dto/history/starforceHistory';
34
34
  import { InspectionInfoDto } from './dto/inspectionInfo';
35
+ import { DateOptions } from '../common/mapleStoryApi';
36
+ import * as base from '../common/mapleStoryApi';
35
37
  import { CashshopNoticeDetailDto } from './dto/notice/cashshopNoticeDetail';
36
38
  import { CashshopNoticeListDto } from './dto/notice/cashshopNoticeList';
37
39
  import { EventNoticeDetailDto } from './dto/notice/eventNoticeDetail';
@@ -46,6 +48,7 @@ import { GuildRankingResponseDto } from './dto/ranking/guildRanking';
46
48
  import { OverallRankingResponseDto } from './dto/ranking/overallRanking';
47
49
  import { TheSeedRankingResponseDto } from './dto/ranking/theSeedRanking';
48
50
  import { UnionRankingResponseDto } from './dto/ranking/unionRanking';
51
+ import { SchedulerCharacterStateDto } from './dto/scheduler/schedulerCharacterState';
49
52
  import { UnionDto } from './dto/union/union';
50
53
  import { UnionArtifactDto } from './dto/union/unionArtifact';
51
54
  import { UnionChampionDto } from './dto/union/unionChampion';
@@ -53,8 +56,6 @@ import { UnionRaiderDto } from './dto/union/unionRaider';
53
56
  import { AchievementDto } from './dto/user/achievement';
54
57
  import { CharacterListDto } from './dto/user/characterList';
55
58
  import { CharacterImageAction, CharacterImageEmotion, CharacterImageWeaponMotion } from '../common/enum/characterImage';
56
- import { DateOptions } from '../common/mapleStoryApi';
57
- import * as base from '../common/mapleStoryApi';
58
59
  /**
59
60
  * MapleStory OpenAPI client for KMS.<br>
60
61
  * This is an implementation of <a href="https://openapi.nexon.com/game/maplestory">MapleStory API</a>
@@ -479,6 +480,13 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
479
480
  * @param replayId 연무장 리플레이 고유 식별자
480
481
  */
481
482
  getBattlePracticeCharacterInfo(replayId: string): Promise<BattlePracticeCharacterInfoDto>;
483
+ /**
484
+ * 캐릭터에 대한 스케줄러의 수행 현황 정보를 조회하는 API입니다.
485
+ *
486
+ * @param ocid 캐릭터 식별자
487
+ * @param dateOptions 조회 기준일 (KST)
488
+ */
489
+ getSchedulerCharacterState(ocid: string, dateOptions?: DateOptions): Promise<SchedulerCharacterStateDto | null>;
482
490
  /**
483
491
  * 스타포스 강화 결과를 조회합니다.
484
492
  * - 스타포스 확률 정보는 최대 5분 후 확인 가능합니다.
@@ -560,7 +568,7 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
560
568
  /**
561
569
  * 종합 랭킹 정보를 조회합니다.
562
570
  * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
563
- * - 오늘의 랭킹 정보는 오전 9시 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
571
+ * - 오늘의 랭킹 정보는 오전 9시 30분 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
564
572
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
565
573
  * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
566
574
  *
@@ -572,7 +580,7 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
572
580
  /**
573
581
  * 유니온 랭킹 정보를 조회합니다.
574
582
  * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
575
- * - 오늘의 랭킹 정보는 오전 9시 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
583
+ * - 오늘의 랭킹 정보는 오전 9시 30분 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
576
584
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
577
585
  * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
578
586
  *
@@ -583,7 +591,7 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
583
591
  /**
584
592
  * 길드 랭킹 정보를 조회합니다.
585
593
  * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
586
- * - 오늘의 랭킹 정보는 오전 9시 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
594
+ * - 오늘의 랭킹 정보는 오전 9시 30분 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
587
595
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
588
596
  * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
589
597
  *
@@ -594,7 +602,7 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
594
602
  /**
595
603
  * 무릉도장 랭킹 정보를 조회합니다.
596
604
  * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
597
- * - 오늘의 랭킹 정보는 오전 9시 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
605
+ * - 오늘의 랭킹 정보는 오전 9시 30분 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
598
606
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
599
607
  * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
600
608
  *
@@ -605,7 +613,7 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
605
613
  /**
606
614
  * 더 시드 랭킹 정보를 조회합니다.
607
615
  * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
608
- * - 오늘의 랭킹 정보는 오전 9시 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
616
+ * - 오늘의 랭킹 정보는 오전 9시 30분 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
609
617
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
610
618
  * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
611
619
  *
@@ -616,7 +624,7 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
616
624
  /**
617
625
  * 업적 랭킹 정보를 조회합니다.
618
626
  * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
619
- * - 오늘의 랭킹 정보는 오전 9시 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
627
+ * - 오늘의 랭킹 정보는 오전 9시 30분 경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
620
628
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
621
629
  * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
622
630
  *
@@ -1,10 +1,10 @@
1
+ import { DateOptions } from '../common/mapleStoryFriendsApi';
2
+ import * as base from '../common/mapleStoryFriendsApi';
1
3
  import { CubeHistoryResponseDto } from './dto/history/cubeHistory';
2
4
  import { PotentialHistoryResponseDto } from './dto/history/potentialHistory';
3
5
  import { StarforceHistoryResponseDto } from './dto/history/starforceHistory';
4
6
  import { AchievementDto } from './dto/user/achievement';
5
7
  import { CharacterListDto } from './dto/user/characterList';
6
- import { DateOptions } from '../common/mapleStoryFriendsApi';
7
- import * as base from '../common/mapleStoryFriendsApi';
8
8
  /**
9
9
  * MapleStory Friends API client for KMS<br>
10
10
  * This is an implementation of <a href="https://openapi.nexon.com/ko/friends/maplestory/?id=36">MapleStory Friends API</a>
@@ -339,6 +339,7 @@ export type BattlePracticeCharacterCashItemOptionBody = {
339
339
  option_value: string;
340
340
  };
341
341
  export type BattlePracticeCharacterPetObjectBody = {
342
+ pet_activate_flag: string | null;
342
343
  pet_1_name: string | null;
343
344
  pet_1_nickname: string | null;
344
345
  pet_1_icon: string | null;
@@ -366,6 +367,40 @@ export type BattlePracticeCharacterPetObjectBody = {
366
367
  pet_3_pet_type: string | null;
367
368
  pet_3_skill: string[];
368
369
  pet_3_date_expire: string | null;
370
+ world_share_pet_1_name: string | null;
371
+ world_share_pet_1_nickname: string | null;
372
+ world_share_pet_1_icon: string | null;
373
+ world_share_pet_1_description: string | null;
374
+ world_share_pet_1_pet_type: string | null;
375
+ world_share_pet_1_equipment: BattlePracticeCharacterPetEquipmentBody | null;
376
+ world_share_pet_1_auto_skill: BattlePracticeCharacterPetAutoSkillBody | null;
377
+ world_share_pet_1_skill: string[];
378
+ world_share_pet_1_date_expire: string | null;
379
+ world_share_pet_2_name: string | null;
380
+ world_share_pet_2_nickname: string | null;
381
+ world_share_pet_2_icon: string | null;
382
+ world_share_pet_2_description: string | null;
383
+ world_share_pet_2_pet_type: string | null;
384
+ world_share_pet_2_equipment: BattlePracticeCharacterPetEquipmentBody | null;
385
+ world_share_pet_2_auto_skill: BattlePracticeCharacterPetAutoSkillBody | null;
386
+ world_share_pet_2_skill: string[];
387
+ world_share_pet_2_date_expire: string | null;
388
+ world_share_pet_3_name: string | null;
389
+ world_share_pet_3_nickname: string | null;
390
+ world_share_pet_3_icon: string | null;
391
+ world_share_pet_3_description: string | null;
392
+ world_share_pet_3_pet_type: string | null;
393
+ world_share_pet_3_equipment: BattlePracticeCharacterPetEquipmentBody | null;
394
+ world_share_pet_3_auto_skill: BattlePracticeCharacterPetAutoSkillBody | null;
395
+ world_share_pet_3_skill: string[];
396
+ world_share_pet_3_date_expire: string | null;
397
+ petite_luna_pet_skill: BattlePracticeCharacterPetiteLunaPetSkillBody[];
398
+ };
399
+ export type BattlePracticeCharacterPetiteLunaPetSkillBody = {
400
+ skill_name: string | null;
401
+ skill_description: string | null;
402
+ skill_effect: string | null;
403
+ skill_icon: string | null;
369
404
  };
370
405
  export type BattlePracticeCharacterPetEquipmentBody = {
371
406
  item_name: string;
@@ -455,6 +490,7 @@ export type BattlePracticeCharacterRingReserveSkillObjectBody = {
455
490
  export type BattlePracticeUnionRaiderObjectBody = {
456
491
  union_raider_stat: string[];
457
492
  union_occupied_stat: string[];
493
+ union_state_stat: string[];
458
494
  };
459
495
  export type BattlePracticeUnionArtifactObjectBody = {
460
496
  union_artifact_effect: BattlePracticeUnionArtifactEffectBody[];
@@ -5,6 +5,7 @@ export type CharacterHexaMatrixBody = {
5
5
  export type CharacterHexaMatrixEquipmentBody = {
6
6
  hexa_core_name: string;
7
7
  hexa_core_level: number;
8
+ hexa_core_event_level: number;
8
9
  hexa_core_type: string;
9
10
  linked_skill: CharacterHexaMatrixEquipmentLinkedSkillBody[];
10
11
  };
@@ -187,6 +187,20 @@ export type CharacterItemEquipmentEtcOptionBody = {
187
187
  };
188
188
  export type CharacterItemEquipmentStarforceOptionBody = CharacterItemEquipmentEtcOptionBody;
189
189
  export type CharacterItemEquipmentTitleBody = {
190
+ preset_no: number | null;
191
+ title_name: string | null;
192
+ title_icon: string | null;
193
+ title_description: string | null;
194
+ date_expire: string | null;
195
+ date_option_expire: string | null;
196
+ title_shape_name: string | null;
197
+ title_shape_icon: string | null;
198
+ title_shape_description: string | null;
199
+ title_preset_1: CharacterItemEquipmentTitlePresetBody | null;
200
+ title_preset_2: CharacterItemEquipmentTitlePresetBody | null;
201
+ title_preset_3: CharacterItemEquipmentTitlePresetBody | null;
202
+ };
203
+ export type CharacterItemEquipmentTitlePresetBody = {
190
204
  title_name: string | null;
191
205
  title_icon: string | null;
192
206
  title_description: string | null;
@@ -195,6 +209,7 @@ export type CharacterItemEquipmentTitleBody = {
195
209
  title_shape_name: string | null;
196
210
  title_shape_icon: string | null;
197
211
  title_shape_description: string | null;
212
+ disable_flag: string | null;
198
213
  };
199
214
  export type CharacterItemEquipmentMedalShapeBody = {
200
215
  medal_shape_name: string;
@@ -1,5 +1,6 @@
1
1
  export type CharacterPetEquipmentBody = {
2
2
  date: string | null;
3
+ pet_activate_flag: string | null;
3
4
  pet_1_name: string | null;
4
5
  pet_1_nickname: string | null;
5
6
  pet_1_icon: string | null;
@@ -33,6 +34,40 @@ export type CharacterPetEquipmentBody = {
33
34
  pet_3_date_expire: string | null;
34
35
  pet_3_appearance: string | null;
35
36
  pet_3_appearance_icon: string | null;
37
+ world_share_pet_1_name: string | null;
38
+ world_share_pet_1_nickname: string | null;
39
+ world_share_pet_1_icon: string | null;
40
+ world_share_pet_1_description: string | null;
41
+ world_share_pet_1_pet_type: string | null;
42
+ world_share_pet_1_equipment: CharacterPetEquipmentItemBody | null;
43
+ world_share_pet_1_auto_skill: CharacterPetEquipmentAutoSkillBody | null;
44
+ world_share_pet_1_skill: string[];
45
+ world_share_pet_1_date_expire: string | null;
46
+ world_share_pet_1_appearance: string | null;
47
+ world_share_pet_1_appearance_icon: string | null;
48
+ world_share_pet_2_name: string | null;
49
+ world_share_pet_2_nickname: string | null;
50
+ world_share_pet_2_icon: string | null;
51
+ world_share_pet_2_description: string | null;
52
+ world_share_pet_2_pet_type: string | null;
53
+ world_share_pet_2_equipment: CharacterPetEquipmentItemBody | null;
54
+ world_share_pet_2_auto_skill: CharacterPetEquipmentAutoSkillBody | null;
55
+ world_share_pet_2_skill: string[];
56
+ world_share_pet_2_date_expire: string | null;
57
+ world_share_pet_2_appearance: string | null;
58
+ world_share_pet_2_appearance_icon: string | null;
59
+ world_share_pet_3_name: string | null;
60
+ world_share_pet_3_nickname: string | null;
61
+ world_share_pet_3_icon: string | null;
62
+ world_share_pet_3_description: string | null;
63
+ world_share_pet_3_pet_type: string | null;
64
+ world_share_pet_3_equipment: CharacterPetEquipmentItemBody | null;
65
+ world_share_pet_3_auto_skill: CharacterPetEquipmentAutoSkillBody | null;
66
+ world_share_pet_3_skill: string[];
67
+ world_share_pet_3_date_expire: string | null;
68
+ world_share_pet_3_appearance: string | null;
69
+ world_share_pet_3_appearance_icon: string | null;
70
+ petite_luna_pet_skill: CharacterPetEquipmentPetiteLunaPetSkillBody[];
36
71
  };
37
72
  export type CharacterPetEquipmentItemBody = {
38
73
  item_name: string | null;
@@ -55,3 +90,9 @@ export type CharacterPetEquipmentAutoSkillBody = {
55
90
  skill_2: string | null;
56
91
  skill_2_icon: string | null;
57
92
  };
93
+ export type CharacterPetEquipmentPetiteLunaPetSkillBody = {
94
+ skill_name: string | null;
95
+ skill_description: string | null;
96
+ skill_effect: string | null;
97
+ skill_icon: string | null;
98
+ };
@@ -3,6 +3,11 @@ export type CharacterVMatrixBody = {
3
3
  character_class: string | null;
4
4
  character_v_core_equipment: CharacterVMatrixCoreEquipmentDtoBody[];
5
5
  character_v_matrix_remain_slot_upgrade_point: number | null;
6
+ character_v_core_equipment_preset_1: CharacterVMatrixCoreEquipmentPresetBody[];
7
+ character_v_core_equipment_preset_2: CharacterVMatrixCoreEquipmentPresetBody[];
8
+ character_v_core_equipment_preset_3: CharacterVMatrixCoreEquipmentPresetBody[];
9
+ character_v_core_equipment_preset_4: CharacterVMatrixCoreEquipmentPresetBody[];
10
+ character_v_core_equipment_preset_5: CharacterVMatrixCoreEquipmentPresetBody[];
6
11
  };
7
12
  export type CharacterVMatrixCoreEquipmentDtoBody = {
8
13
  slot_id: string;
@@ -10,7 +15,12 @@ export type CharacterVMatrixCoreEquipmentDtoBody = {
10
15
  v_core_name: string | null;
11
16
  v_core_type: string | null;
12
17
  v_core_level: number;
13
- v_core_skill_1: string;
18
+ v_core_skill_1: string | null;
14
19
  v_core_skill_2: string | null;
15
20
  v_core_skill_3: string | null;
16
21
  };
22
+ export type CharacterVMatrixCoreEquipmentPresetBody = {
23
+ v_core_name: string | null;
24
+ v_core_type: string | null;
25
+ v_core_level: number;
26
+ };
@@ -0,0 +1,36 @@
1
+ export type SchedulerCharacterStateBody = {
2
+ date: string | null;
3
+ character_name: string;
4
+ world_name: string;
5
+ character_level: number;
6
+ character_class: string;
7
+ daily_contents: SchedulerDailyContentBody[];
8
+ weekly_contents: SchedulerWeeklyContentBody[];
9
+ boss_contents: SchedulerBossContentBody[];
10
+ weekly_boss_clear_count: number;
11
+ weekly_boss_clear_limit_count: number;
12
+ };
13
+ export type SchedulerDailyContentBody = {
14
+ content_name: string;
15
+ type: string;
16
+ registration_flag: string;
17
+ now_count: number;
18
+ max_count: number;
19
+ quest_state: string | null;
20
+ };
21
+ export type SchedulerWeeklyContentBody = {
22
+ content_name: string;
23
+ type: string;
24
+ registration_flag: string;
25
+ now_count: number;
26
+ max_count: number;
27
+ quest_state: string | null;
28
+ };
29
+ export type SchedulerBossContentBody = {
30
+ content_name: string;
31
+ difficulty: string;
32
+ cycle: string;
33
+ list_order_no: number;
34
+ registration_flag: string;
35
+ complete_flag: string;
36
+ };
@@ -10,6 +10,9 @@ export type UnionRaiderBody = {
10
10
  union_raider_preset_3: UnionRaiderPresetBody | null;
11
11
  union_raider_preset_4: UnionRaiderPresetBody | null;
12
12
  union_raider_preset_5: UnionRaiderPresetBody | null;
13
+ union_state_stat: string[];
14
+ union_state_stat_preset: UnionRaiderStateStatPresetBody[];
15
+ union_max_point: number | null;
13
16
  };
14
17
  export type UnionRaiderInnerStatBody = {
15
18
  stat_field_id: string;
@@ -36,3 +39,7 @@ export type UnionRaiderPresetBody = {
36
39
  union_inner_stat: UnionRaiderInnerStatBody[];
37
40
  union_block: UnionRaiderBlockBody[];
38
41
  };
42
+ export type UnionRaiderStateStatPresetBody = {
43
+ preset_no: number;
44
+ union_state_stat: string[];
45
+ };
@@ -0,0 +1,117 @@
1
+ import { CharacterFamiliarBody, CharacterFamiliarInfoBody, CharacterFamiliarInfoOptionBody, CharacterFamiliarLinkSlotBody } from '../../response/character/characterFamiliarBody';
2
+ /**
3
+ * 萌獸 資訊
4
+ */
5
+ export declare class CharacterFamiliarDto {
6
+ /**
7
+ * 要搜尋的日期 (TST,每日資料中的小時與分鐘將顯示為 0)
8
+ */
9
+ date: Date | null;
10
+ /**
11
+ * 萌獸 鏈路插槽資訊
12
+ */
13
+ familiarLinkSlot: CharacterFamiliarLinkSlotDto[];
14
+ /**
15
+ * 萌獸 細節
16
+ */
17
+ familiarInfo: CharacterFamiliarInfoDto[];
18
+ constructor(obj: CharacterFamiliarBody);
19
+ }
20
+ /**
21
+ * 萌獸 鏈路插槽資訊
22
+ */
23
+ export declare class CharacterFamiliarLinkSlotDto {
24
+ /**
25
+ * 插槽標識符 (1~3, vip)
26
+ */
27
+ slotId: string;
28
+ /**
29
+ * 連結的 萌獸 名稱 (如果插槽中沒有任何關聯,則為 null)
30
+ */
31
+ familiarName: string | null;
32
+ /**
33
+ * 已啟用還是未啟用 (true, false)
34
+ */
35
+ activeFlag: string;
36
+ /**
37
+ * 截止日期
38
+ */
39
+ expireDate: Date | null;
40
+ constructor(obj: CharacterFamiliarLinkSlotBody);
41
+ }
42
+ /**
43
+ * 萌獸 細節
44
+ */
45
+ export declare class CharacterFamiliarInfoDto {
46
+ /**
47
+ * 萌獸 名稱
48
+ */
49
+ familiarName: string;
50
+ /**
51
+ * 萌獸 暱稱
52
+ */
53
+ familiarNickname: string;
54
+ /**
55
+ * 特別與否
56
+ */
57
+ familiarSpecialFlag: string;
58
+ /**
59
+ * 萌獸 情況
60
+ */
61
+ familiarState: string;
62
+ /**
63
+ * 等級
64
+ */
65
+ familiarLevel: number;
66
+ /**
67
+ * 經驗
68
+ */
69
+ familiarExp: number;
70
+ /**
71
+ * 具備的技能
72
+ */
73
+ skillName: string | null;
74
+ /**
75
+ * 選項等級
76
+ */
77
+ optionLevel: number;
78
+ /**
79
+ * 選項訊息
80
+ */
81
+ option: CharacterFamiliarInfoOptionDto[];
82
+ /**
83
+ * 等級
84
+ */
85
+ familiarGrade: string;
86
+ /**
87
+ * 外觀名稱
88
+ */
89
+ lookName: string | null;
90
+ /**
91
+ * 當前是否已被召喚
92
+ */
93
+ summonedFlag: string;
94
+ /**
95
+ * 連結槽索引 (1~3, vip, not link)
96
+ */
97
+ slotId: string;
98
+ constructor(obj: CharacterFamiliarInfoBody);
99
+ }
100
+ /**
101
+ * 選項訊息
102
+ */
103
+ export declare class CharacterFamiliarInfoOptionDto {
104
+ /**
105
+ * 選項號
106
+ */
107
+ optionNo: number;
108
+ /**
109
+ * 選項名稱
110
+ */
111
+ optionName: string;
112
+ /**
113
+ * 選擇權價值
114
+ */
115
+ optionValue: string;
116
+ constructor(obj: CharacterFamiliarInfoOptionBody);
117
+ }
@@ -1,5 +1,5 @@
1
1
  import * as base from '../../../common/dto/character/characterPetEquipment';
2
- import { CharacterPetEquipmentAutoSkillBody, CharacterPetEquipmentBody, CharacterPetEquipmentItemBody, CharacterPetEquipmentItemOptionBody } from '../../response/character/characterPetEquipmentBody';
2
+ import { CharacterPetEquipmentAutoSkillBody, CharacterPetEquipmentBody, CharacterPetEquipmentItemBody, CharacterPetEquipmentItemOptionBody, CharacterPetEquipmentPotentialBody } from '../../response/character/characterPetEquipmentBody';
3
3
  /**
4
4
  * 角色已裝備寵物資訊
5
5
  */
@@ -56,6 +56,10 @@ export declare class CharacterPetEquipmentDto extends base.CharacterPetEquipment
56
56
  * 寵物 1 外型圖示
57
57
  */
58
58
  pet1AppearanceIcon: string | null;
59
+ /**
60
+ * 寵物1 潛在的
61
+ */
62
+ pet1Potential: CharacterPetEquipmentPotentialDto[];
59
63
  /**
60
64
  * 寵物 2 名稱
61
65
  */
@@ -104,6 +108,10 @@ export declare class CharacterPetEquipmentDto extends base.CharacterPetEquipment
104
108
  * 寵物 2 外型圖示
105
109
  */
106
110
  pet2AppearanceIcon: string | null;
111
+ /**
112
+ * 寵物2 潛在的
113
+ */
114
+ pet2Potential: CharacterPetEquipmentPotentialDto[];
107
115
  /**
108
116
  * 寵物 3 名稱
109
117
  */
@@ -152,6 +160,10 @@ export declare class CharacterPetEquipmentDto extends base.CharacterPetEquipment
152
160
  * 寵物 3 外型圖示
153
161
  */
154
162
  pet3AppearanceIcon: string | null;
163
+ /**
164
+ * 寵物3 潛在的
165
+ */
166
+ pet3Potential: CharacterPetEquipmentPotentialDto[];
155
167
  constructor(obj: CharacterPetEquipmentBody);
156
168
  }
157
169
  /**
@@ -228,3 +240,25 @@ export declare class CharacterPetEquipmentItemDto extends base.CharacterPetEquip
228
240
  itemShapeIcon: string | null;
229
241
  constructor(obj: CharacterPetEquipmentItemBody);
230
242
  }
243
+ /**
244
+ * 寵物 潛在的
245
+ */
246
+ export declare class CharacterPetEquipmentPotentialDto {
247
+ /**
248
+ * 潛在的 步 (1~3, 0:停用)
249
+ */
250
+ potentialStep: string;
251
+ /**
252
+ * 潛在的 類型
253
+ */
254
+ potentialType: string | null;
255
+ /**
256
+ * 潛在的 增加 (對於攻擊力/魔法攻擊力以外的其他潛在能力類型,百分比)
257
+ */
258
+ potentialIncrease1: string | null;
259
+ /**
260
+ * 潛在的 增加 2 (如果潛在能力類型為攻擊力/魔法攻擊力,則攻擊力分配給 potential_increase_1,魔法攻擊力分配給 potential_increase_2;如果潛在能力類型為最大生命值/最大魔法值,則最大生命值分配給 potential_increase_1,最大魔法值分配給 potential_increase_2。)
261
+ */
262
+ potentialIncrease2: string | null;
263
+ constructor(obj: CharacterPetEquipmentPotentialBody);
264
+ }
@@ -6,6 +6,7 @@ export * from './dto/character/characterBasic';
6
6
  export * from './dto/character/characterBeautyEquipment';
7
7
  export * from './dto/character/characterCashItemEquipment';
8
8
  export * from './dto/character/characterDojang';
9
+ export * from './dto/character/characterFamiliar';
9
10
  export * from './dto/character/characterHexaMatrix';
10
11
  export * from './dto/character/characterHexaMatrixStat';
11
12
  export * from './dto/character/characterHyperStat';
@@ -5,6 +5,7 @@ import { CharacterBasicDto } from './dto/character/characterBasic';
5
5
  import { CharacterBeautyEquipmentDto } from './dto/character/characterBeautyEquipment';
6
6
  import { CharacterCashItemEquipmentDto } from './dto/character/characterCashItemEquipment';
7
7
  import { CharacterDojangDto } from './dto/character/characterDojang';
8
+ import { CharacterFamiliarDto } from './dto/character/characterFamiliar';
8
9
  import { CharacterHexaMatrixDto } from './dto/character/characterHexaMatrix';
9
10
  import { CharacterHexaMatrixStatDto } from './dto/character/characterHexaMatrixStat';
10
11
  import { CharacterHyperStatDto } from './dto/character/characterHyperStat';
@@ -268,6 +269,17 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
268
269
  * @param dateOptions 要搜尋的日期 (TST)
269
270
  */
270
271
  getCharacterDojang(ocid: string, dateOptions?: DateOptions): Promise<CharacterDojangDto | null>;
272
+ /**
273
+ * 檢視萌獸資訊。
274
+ * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
275
+ * - 您可以從 2025 年 10 月 15 日起搜尋資料。
276
+ * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時,將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
277
+ * - 由於遊戲內容變動,OCID 可能會有所變更。在更新以 OCID 為基礎的服務時,請務必留意。
278
+ * - 此 API 提供來自楓之谷台灣的資料。
279
+ * @param ocid 角色辨識器
280
+ * @param dateOptions 要搜尋的日期 (TST)
281
+ */
282
+ getCharacterFamiliar(ocid: string, dateOptions?: DateOptions): Promise<CharacterFamiliarDto | null>;
271
283
  /**
272
284
  * 檢視戰地等級與戰地階級資訊。
273
285
  * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
@@ -0,0 +1,31 @@
1
+ export type CharacterFamiliarBody = {
2
+ date: string | null;
3
+ familiar_link_slot: CharacterFamiliarLinkSlotBody[];
4
+ familiar_info: CharacterFamiliarInfoBody[];
5
+ };
6
+ export type CharacterFamiliarLinkSlotBody = {
7
+ slot_id: string | null;
8
+ familiar_name: string | null;
9
+ active_flag: string | null;
10
+ expire_date: string | null;
11
+ };
12
+ export type CharacterFamiliarInfoBody = {
13
+ familiar_name: string | null;
14
+ familiar_nickname: string | null;
15
+ familiar_special_flag: string | null;
16
+ familiar_state: string | null;
17
+ familiar_level: number;
18
+ familiar_exp: number;
19
+ skill_name: string | null;
20
+ option_level: number;
21
+ option: CharacterFamiliarInfoOptionBody[];
22
+ familiar_grade: string | null;
23
+ look_name: string | null;
24
+ summoned_flag: string | null;
25
+ slot_id: string | null;
26
+ };
27
+ export type CharacterFamiliarInfoOptionBody = {
28
+ option_no: number;
29
+ option_name: string | null;
30
+ option_value: string | null;
31
+ };
@@ -11,6 +11,7 @@ export type CharacterPetEquipmentBody = {
11
11
  pet_1_date_expire: string | null;
12
12
  pet_1_appearance: string | null;
13
13
  pet_1_appearance_icon: string | null;
14
+ pet_1_potential: CharacterPetEquipmentPotentialBody[];
14
15
  pet_2_name: string | null;
15
16
  pet_2_nickname: string | null;
16
17
  pet_2_icon: string | null;
@@ -22,6 +23,7 @@ export type CharacterPetEquipmentBody = {
22
23
  pet_2_date_expire: string | null;
23
24
  pet_2_appearance: string | null;
24
25
  pet_2_appearance_icon: string | null;
26
+ pet_2_potential: CharacterPetEquipmentPotentialBody[];
25
27
  pet_3_name: string | null;
26
28
  pet_3_nickname: string | null;
27
29
  pet_3_icon: string | null;
@@ -33,6 +35,7 @@ export type CharacterPetEquipmentBody = {
33
35
  pet_3_date_expire: string | null;
34
36
  pet_3_appearance: string | null;
35
37
  pet_3_appearance_icon: string | null;
38
+ pet_3_potential: CharacterPetEquipmentPotentialBody[];
36
39
  };
37
40
  export type CharacterPetEquipmentItemBody = {
38
41
  item_name: string | null;
@@ -54,3 +57,9 @@ export type CharacterPetEquipmentAutoSkillBody = {
54
57
  skill_2: string | null;
55
58
  skill_2_icon: string | null;
56
59
  };
60
+ export type CharacterPetEquipmentPotentialBody = {
61
+ potential_step: string;
62
+ potential_type: string | null;
63
+ potential_increase1: string | null;
64
+ potential_increase2: string | null;
65
+ };