maplestory-openapi 3.7.0 → 3.8.1

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 (84) hide show
  1. package/dist/cjs/index.js +5 -0
  2. package/dist/cjs/maplestory/api/common/dto/character/characterItemEquipment.js +3 -0
  3. package/dist/cjs/maplestory/api/common/dto/union/unionChampion.js +14 -0
  4. package/dist/cjs/maplestory/api/kms/dto/character/characterItemEquipment.js +2 -1
  5. package/dist/cjs/maplestory/api/kms/dto/union/unionChampion.js +8 -3
  6. package/dist/cjs/maplestory/api/kms/mapleStoryApi.js +26 -20
  7. package/dist/cjs/maplestory/api/msea/dto/character/characterAndroidEquipment.js +36 -3
  8. package/dist/cjs/maplestory/api/msea/dto/character/characterBasic.js +4 -10
  9. package/dist/cjs/maplestory/api/msea/dto/character/characterBeautyEquipment.js +24 -2
  10. package/dist/cjs/maplestory/api/msea/dto/character/characterCashItemEquipment.js +17 -1
  11. package/dist/cjs/maplestory/api/msea/dto/character/characterItemEquipment.js +100 -5
  12. package/dist/cjs/maplestory/api/msea/dto/union/unionChampion.js +82 -0
  13. package/dist/cjs/maplestory/api/msea/mapleStoryApi.js +32 -0
  14. package/dist/cjs/maplestory/api/msea/msea.js +5 -0
  15. package/dist/cjs/maplestory/api/tms/dto/character/characterAndroidEquipment.js +36 -3
  16. package/dist/cjs/maplestory/api/tms/dto/character/characterBasic.js +1 -1
  17. package/dist/cjs/maplestory/api/tms/dto/character/characterBeautyEquipment.js +24 -2
  18. package/dist/cjs/maplestory/api/tms/dto/character/characterCashItemEquipment.js +12 -1
  19. package/dist/cjs/maplestory/api/tms/dto/character/characterItemEquipment.js +84 -4
  20. package/dist/cjs/maplestory/api/tms/dto/union/unionChampion.js +79 -0
  21. package/dist/cjs/maplestory/api/tms/mapleStoryApi.js +32 -0
  22. package/dist/cjs/maplestory/api/tms/tms.js +5 -0
  23. package/dist/esm/index.js +2 -1
  24. package/dist/esm/maplestory/api/common/dto/character/characterItemEquipment.js +3 -1
  25. package/dist/esm/maplestory/api/common/dto/union/unionChampion.js +8 -0
  26. package/dist/esm/maplestory/api/kms/dto/character/characterItemEquipment.js +3 -2
  27. package/dist/esm/maplestory/api/kms/dto/union/unionChampion.js +8 -3
  28. package/dist/esm/maplestory/api/kms/mapleStoryApi.js +26 -20
  29. package/dist/esm/maplestory/api/msea/dto/character/characterAndroidEquipment.js +36 -3
  30. package/dist/esm/maplestory/api/msea/dto/character/characterBasic.js +4 -10
  31. package/dist/esm/maplestory/api/msea/dto/character/characterBeautyEquipment.js +24 -2
  32. package/dist/esm/maplestory/api/msea/dto/character/characterCashItemEquipment.js +17 -1
  33. package/dist/esm/maplestory/api/msea/dto/character/characterItemEquipment.js +101 -7
  34. package/dist/esm/maplestory/api/msea/dto/union/unionChampion.js +76 -0
  35. package/dist/esm/maplestory/api/msea/mapleStoryApi.js +32 -0
  36. package/dist/esm/maplestory/api/msea/msea.js +2 -1
  37. package/dist/esm/maplestory/api/tms/dto/character/characterAndroidEquipment.js +36 -3
  38. package/dist/esm/maplestory/api/tms/dto/character/characterBasic.js +1 -1
  39. package/dist/esm/maplestory/api/tms/dto/character/characterBeautyEquipment.js +24 -2
  40. package/dist/esm/maplestory/api/tms/dto/character/characterCashItemEquipment.js +12 -1
  41. package/dist/esm/maplestory/api/tms/dto/character/characterItemEquipment.js +85 -6
  42. package/dist/esm/maplestory/api/tms/dto/union/unionChampion.js +73 -0
  43. package/dist/esm/maplestory/api/tms/mapleStoryApi.js +32 -0
  44. package/dist/esm/maplestory/api/tms/tms.js +2 -1
  45. package/dist/index.min.js +1 -1
  46. package/package.json +1 -1
  47. package/types/index.d.ts +1 -0
  48. package/types/maplestory/api/common/dto/character/characterAndroidEquipment.d.ts +3 -0
  49. package/types/maplestory/api/common/dto/character/characterBasic.d.ts +1 -0
  50. package/types/maplestory/api/common/dto/character/characterBeautyEquipment.d.ts +2 -0
  51. package/types/maplestory/api/common/dto/character/characterCashItemEquipment.d.ts +2 -0
  52. package/types/maplestory/api/common/dto/character/characterItemEquipment.d.ts +15 -0
  53. package/types/maplestory/api/common/dto/union/unionChampion.d.ts +15 -0
  54. package/types/maplestory/api/common/mapleStoryApi.d.ts +2 -0
  55. package/types/maplestory/api/kms/dto/character/characterItemEquipment.d.ts +1 -1
  56. package/types/maplestory/api/kms/dto/union/unionChampion.d.ts +4 -3
  57. package/types/maplestory/api/kms/mapleStoryApi.d.ts +13 -7
  58. package/types/maplestory/api/msea/dto/character/characterAndroidEquipment.d.ts +24 -0
  59. package/types/maplestory/api/msea/dto/character/characterBasic.d.ts +2 -6
  60. package/types/maplestory/api/msea/dto/character/characterBeautyEquipment.d.ts +16 -0
  61. package/types/maplestory/api/msea/dto/character/characterCashItemEquipment.d.ts +12 -0
  62. package/types/maplestory/api/msea/dto/character/characterItemEquipment.d.ts +71 -1
  63. package/types/maplestory/api/msea/dto/union/unionChampion.d.ts +56 -0
  64. package/types/maplestory/api/msea/index.d.ts +1 -0
  65. package/types/maplestory/api/msea/mapleStoryApi.d.ts +12 -0
  66. package/types/maplestory/api/msea/response/character/characterAndroidEquipmentBody.d.ts +3 -0
  67. package/types/maplestory/api/msea/response/character/characterBasicBody.d.ts +1 -1
  68. package/types/maplestory/api/msea/response/character/characterBeautyEquipmentBody.d.ts +2 -0
  69. package/types/maplestory/api/msea/response/character/characterCashItemEquipmentBody.d.ts +2 -0
  70. package/types/maplestory/api/msea/response/character/characterItemEquipmentBody.d.ts +14 -0
  71. package/types/maplestory/api/msea/response/union/unionChampionBody.d.ts +15 -0
  72. package/types/maplestory/api/tms/dto/character/characterAndroidEquipment.d.ts +24 -0
  73. package/types/maplestory/api/tms/dto/character/characterBasic.d.ts +1 -1
  74. package/types/maplestory/api/tms/dto/character/characterBeautyEquipment.d.ts +16 -0
  75. package/types/maplestory/api/tms/dto/character/characterCashItemEquipment.d.ts +8 -0
  76. package/types/maplestory/api/tms/dto/character/characterItemEquipment.d.ts +59 -1
  77. package/types/maplestory/api/tms/dto/union/unionChampion.d.ts +53 -0
  78. package/types/maplestory/api/tms/index.d.ts +1 -0
  79. package/types/maplestory/api/tms/mapleStoryApi.d.ts +12 -0
  80. package/types/maplestory/api/tms/response/character/characterAndroidEquipmentBody.d.ts +3 -0
  81. package/types/maplestory/api/tms/response/character/characterBeautyEquipmentBody.d.ts +2 -0
  82. package/types/maplestory/api/tms/response/character/characterCashItemEquipmentBody.d.ts +1 -0
  83. package/types/maplestory/api/tms/response/character/characterItemEquipmentBody.d.ts +11 -0
  84. package/types/maplestory/api/tms/response/union/unionChampionBody.d.ts +15 -0
@@ -103,7 +103,7 @@ export declare class CharacterItemEquipmentTitleDto extends base.CharacterItemEq
103
103
  /**
104
104
  * 캐릭터 외형 설정에 등록한 훈장 외형 정보
105
105
  */
106
- export declare class CharacterItemEquipmentMedalShapeDto {
106
+ export declare class CharacterItemEquipmentMedalShapeDto extends base.CharacterItemEquipmentMedalShapeDto {
107
107
  /**
108
108
  * 외형 설정에 등록한 훈장 장비 명
109
109
  */
@@ -1,8 +1,9 @@
1
+ import * as base from '../../../common/dto/union/unionChampion';
1
2
  import { UnionChampionBadgeInfoBody, UnionChampionBody, UnionChampionInfoBody } from '../../response/union/unionChampionBody';
2
3
  /**
3
4
  * 유니온 챔피언 정보
4
5
  */
5
- export declare class UnionChampionDto {
6
+ export declare class UnionChampionDto extends base.UnionChampionDto {
6
7
  /**
7
8
  * 조회 기준일 (KST, 일 단위 데이터로 시, 분은 일괄 0으로 표기)
8
9
  */
@@ -20,7 +21,7 @@ export declare class UnionChampionDto {
20
21
  /**
21
22
  * 유니온 챔피언 휘장 정보
22
23
  */
23
- export declare class UnionChampionBadgeInfoDto {
24
+ export declare class UnionChampionBadgeInfoDto extends base.UnionChampionBadgeInfoDto {
24
25
  /**
25
26
  * 유니온 챔피언 휘장 효과
26
27
  */
@@ -30,7 +31,7 @@ export declare class UnionChampionBadgeInfoDto {
30
31
  /**
31
32
  * 유니온 챔피언 상세 정보
32
33
  */
33
- export declare class UnionChampionInfoDto {
34
+ export declare class UnionChampionInfoDto extends base.UnionChampionInfoDto {
34
35
  /**
35
36
  * 유니온 챔피언 캐릭터 명
36
37
  */
@@ -504,9 +504,10 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
504
504
  getPotentialHistory(count: number, cursor: string): Promise<PotentialHistoryResponseDto>;
505
505
  /**
506
506
  * 종합 랭킹 정보를 조회합니다.
507
- * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
508
- * - 오전 830분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
507
+ * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
508
+ * - 오늘의 랭킹 정보는 오전 9경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
509
509
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
510
+ * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
510
511
  *
511
512
  * @param filterOptions 검색 기준
512
513
  * @param dateOptions 조회 기준일 (KST).
@@ -516,8 +517,9 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
516
517
  /**
517
518
  * 유니온 랭킹 정보를 조회합니다.
518
519
  * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
519
- * - 오전 830분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
520
+ * - 오늘의 랭킹 정보는 오전 9경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
520
521
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
522
+ * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
521
523
  *
522
524
  * @param filterOptions 검색 기준
523
525
  * @param dateOptions 조회 기준일 (KST)
@@ -526,8 +528,9 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
526
528
  /**
527
529
  * 길드 랭킹 정보를 조회합니다.
528
530
  * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
529
- * - 오전 830분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
531
+ * - 오늘의 랭킹 정보는 오전 9경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
530
532
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
533
+ * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
531
534
  *
532
535
  * @param filterOptions 검색 기준
533
536
  * @param dateOptions 조회 기준일 (KST)
@@ -536,8 +539,9 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
536
539
  /**
537
540
  * 무릉도장 랭킹 정보를 조회합니다.
538
541
  * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
539
- * - 오전 830분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
542
+ * - 오늘의 랭킹 정보는 오전 9경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
540
543
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
544
+ * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
541
545
  *
542
546
  * @param filterOptions 검색 기준
543
547
  * @param dateOptions 조회 기준일 (KST)
@@ -546,8 +550,9 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
546
550
  /**
547
551
  * 더 시드 랭킹 정보를 조회합니다.
548
552
  * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
549
- * - 오전 830분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
553
+ * - 오늘의 랭킹 정보는 오전 9경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
550
554
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
555
+ * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
551
556
  *
552
557
  * @param filterOptions 검색 기준
553
558
  * @param dateOptions 조회 기준일 (KST)
@@ -556,8 +561,9 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
556
561
  /**
557
562
  * 업적 랭킹 정보를 조회합니다.
558
563
  * - 2023년 12월 22일 데이터부터 조회할 수 있습니다.
559
- * - 오전 830분부터 오늘의 랭킹 정보를 조회할 수 있습니다.
564
+ * - 오늘의 랭킹 정보는 오전 9경부터 조회가 가능합니다. 상황에 따라 시간이 더 소요될 수 있습니다.
560
565
  * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
566
+ * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
561
567
  *
562
568
  * @param filterOptions 검색 기준
563
569
  * @param dateOptions 조회 기준일 (KST)
@@ -98,7 +98,15 @@ export declare class CharacterAndroidEquipmentFaceDto extends base.CharacterAndr
98
98
  * Dye ratio for Android mixed face color
99
99
  */
100
100
  mixRate: string;
101
+ /**
102
+ * Freestyle Coupon application status (0:not applied, 1:applied)
103
+ */
104
+ freestyleFlag: string | null;
101
105
  constructor(obj: CharacterAndroidEquipmentFaceBody);
106
+ /**
107
+ * Freestyle Coupon application status
108
+ */
109
+ get isFreestyleFlag(): boolean;
102
110
  }
103
111
  /**
104
112
  * Android hair information
@@ -120,7 +128,15 @@ export declare class CharacterAndroidEquipmentHairDto extends base.CharacterAndr
120
128
  * Dye ratio for Android mixed hair color
121
129
  */
122
130
  mixRate: string;
131
+ /**
132
+ * Freestyle Coupon application status (0:not applied, 1:applied)
133
+ */
134
+ freestyleFlag: string | null;
123
135
  constructor(obj: CharacterAndroidEquipmentHairBody);
136
+ /**
137
+ * Freestyle Coupon application status
138
+ */
139
+ get isFreestyleFlag(): boolean;
124
140
  }
125
141
  /**
126
142
  * Android skin information
@@ -295,5 +311,13 @@ export declare class CharacterAndroidCashItemEquipmentDto extends base.Character
295
311
  * Gender compatibility for item equipment
296
312
  */
297
313
  androidItemGender: string | null;
314
+ /**
315
+ * Freestyle Coupon application status (0:not applied, 1:applied)
316
+ */
317
+ freestyleFlag: string | null;
298
318
  constructor(obj: CharacterAndroidCashItemEquipmentBody);
319
+ /**
320
+ * Freestyle Coupon application status
321
+ */
322
+ get isFreestyleFlag(): boolean;
299
323
  }
@@ -57,16 +57,12 @@ export declare class CharacterBasicDto extends base.CharacterBasicDto {
57
57
  */
58
58
  accessFlag: 'true' | 'false';
59
59
  /**
60
- * Liberation quest completion status (true:completed, false:not completed)
60
+ * Liberation Quest completion status (0:not completed, 1:Genesis Weapon liberated, 2:Destiny Weapon Phase 1 liberated)
61
61
  */
62
- liberationQuestClearFlag: 'true' | 'false';
62
+ liberationQuestClear: string;
63
63
  constructor(obj: CharacterBasicBody);
64
64
  /**
65
65
  * Login status in the past 7 days
66
66
  */
67
67
  get isAccessFlag(): boolean;
68
- /**
69
- * Liberation quest completion status
70
- */
71
- get isLiberationQuestClearFlag(): boolean;
72
68
  }
@@ -65,7 +65,15 @@ export declare class CharacterBeautyEquipmentFaceDto extends base.CharacterBeaut
65
65
  * Dye ratio for mixed face color
66
66
  */
67
67
  mixRate: string;
68
+ /**
69
+ * Freestyle Coupon application status (0:not applied, 1:applied)
70
+ */
71
+ freestyleFlag: string | null;
68
72
  constructor(obj: CharacterBeautyEquipmentFaceBody);
73
+ /**
74
+ * Freestyle Coupon application status
75
+ */
76
+ get isFreestyleFlag(): boolean;
69
77
  }
70
78
  /**
71
79
  * Character hair information
@@ -87,7 +95,15 @@ export declare class CharacterBeautyEquipmentHairDto extends base.CharacterBeaut
87
95
  * Dye ratio for mixed hair color
88
96
  */
89
97
  mixRate: string;
98
+ /**
99
+ * Freestyle Coupon application status (0:not applied, 1:applied)
100
+ */
101
+ freestyleFlag: string | null;
90
102
  constructor(obj: CharacterBeautyEquipmentHairBody);
103
+ /**
104
+ * Freestyle Coupon application status
105
+ */
106
+ get isFreestyleFlag(): boolean;
91
107
  }
92
108
  /**
93
109
  * Character skin information
@@ -150,5 +150,17 @@ export declare class CharacterCashItemEquipmentPresetDto extends base.CharacterC
150
150
  * Gender compatibility for item equipment
151
151
  */
152
152
  itemGender: string | null;
153
+ /**
154
+ * Skill name
155
+ */
156
+ skills: string[];
157
+ /**
158
+ * Freestyle Coupon application status (0:not applied, 1:applied)
159
+ */
160
+ freestyleFlag: string | null;
153
161
  constructor(obj: CharacterCashItemEquipmentPresetBody);
162
+ /**
163
+ * Freestyle Coupon application status
164
+ */
165
+ get isFreestyleFlag(): boolean;
154
166
  }
@@ -1,5 +1,5 @@
1
1
  import * as base from '../../../common/dto/character/characterItemEquipment';
2
- import { CharacterItemEquipmentAddOptionBody, CharacterItemEquipmentBaseOptionBody, CharacterItemEquipmentBody, CharacterItemEquipmentDragonInfoBody, CharacterItemEquipmentEtcOptionBody, CharacterItemEquipmentExceptionalOptionBody, CharacterItemEquipmentInfoBody, CharacterItemEquipmentMechanicInfoBody, CharacterItemEquipmentStarforceOptionBody, CharacterItemEquipmentTitleBody, CharacterItemEquipmentTotalOptionBody } from '../../response/character/characterItemEquipmentBody';
2
+ import { CharacterItemEquipmentAddOptionBody, CharacterItemEquipmentBaseOptionBody, CharacterItemEquipmentBody, CharacterItemEquipmentDragonInfoBody, CharacterItemEquipmentEtcOptionBody, CharacterItemEquipmentExceptionalOptionBody, CharacterItemEquipmentInfoBody, CharacterItemEquipmentMechanicInfoBody, CharacterItemEquipmentMedalShapeBody, CharacterItemEquipmentStarforceOptionBody, CharacterItemEquipmentTitleBody, CharacterItemEquipmentTotalOptionBody } from '../../response/character/characterItemEquipmentBody';
3
3
  /**
4
4
  * Character equipped equipment information
5
5
  */
@@ -40,6 +40,10 @@ export declare class CharacterItemEquipmentDto extends base.CharacterItemEquipme
40
40
  * Title information
41
41
  */
42
42
  title: CharacterItemEquipmentTitleDto | null;
43
+ /**
44
+ * Medal appearance information registered in the appearance settings
45
+ */
46
+ medalShape: CharacterItemEquipmentMedalShapeDto | null;
43
47
  /**
44
48
  * Evan Dragon equipment information (response provided if the character is Evan)
45
49
  */
@@ -82,8 +86,50 @@ export declare class CharacterItemEquipmentTitleDto extends base.CharacterItemEq
82
86
  * Whether the title option is expired
83
87
  */
84
88
  isOptionExpired: boolean | null;
89
+ /**
90
+ * Title equipment name registered in the appearance settings
91
+ */
92
+ titleShapeName: string | null;
93
+ /**
94
+ * Title icon registered in the appearance settings
95
+ */
96
+ titleShapeIcon: string | null;
97
+ /**
98
+ * Title description registered in the appearance settings
99
+ */
100
+ titleShapeDescription: string | null;
85
101
  constructor(obj: CharacterItemEquipmentTitleBody);
86
102
  }
103
+ /**
104
+ * Medal appearance information
105
+ */
106
+ export declare class CharacterItemEquipmentMedalShapeDto extends base.CharacterItemEquipmentMedalShapeDto {
107
+ /**
108
+ * Medal equipment name registered in the appearance settings
109
+ */
110
+ medalShapeName: string;
111
+ /**
112
+ * Medal icon registered in the appearance settings
113
+ */
114
+ medalShapeIcon: string;
115
+ /**
116
+ * Medal description registered in the appearance settings
117
+ */
118
+ medalShapeDescription: string;
119
+ /**
120
+ * Fusion Anvil-applied medal equipment name registered in the appearance settings
121
+ */
122
+ medalShapeChangedName: string;
123
+ /**
124
+ * Fusion Anvil-applied medal icon registered in the appearance settings
125
+ */
126
+ medalShapeChangedIcon: string;
127
+ /**
128
+ * Fusion Anvil-applied medal description registered in the appearance settings
129
+ */
130
+ medalShapeChangedDescription: string;
131
+ constructor(obj: CharacterItemEquipmentMedalShapeBody);
132
+ }
87
133
  /**
88
134
  * Additional equipment options
89
135
  */
@@ -564,7 +610,15 @@ export declare class CharacterItemEquipmentDragonInfoDto extends base.CharacterI
564
610
  * Whether the equipment is expired
565
611
  */
566
612
  isExpired: boolean | null;
613
+ /**
614
+ * Freestyle Coupon application status (0:not applied, 1:applied)
615
+ */
616
+ freestyleFlag: string | null;
567
617
  constructor(obj: CharacterItemEquipmentDragonInfoBody);
618
+ /**
619
+ * Freestyle Coupon application status
620
+ */
621
+ get isFreestyleFlag(): boolean;
568
622
  }
569
623
  /**
570
624
  * Mechanic equipment information
@@ -686,7 +740,15 @@ export declare class CharacterItemEquipmentMechanicInfoDto extends base.Characte
686
740
  * Whether the equipment is expired
687
741
  */
688
742
  isExpired: boolean | null;
743
+ /**
744
+ * Freestyle Coupon application status (0:not applied, 1:applied)
745
+ */
746
+ freestyleFlag: string | null;
689
747
  constructor(obj: CharacterItemEquipmentMechanicInfoBody);
748
+ /**
749
+ * Freestyle Coupon application status
750
+ */
751
+ get isFreestyleFlag(): boolean;
690
752
  }
691
753
  /**
692
754
  * Equipment information
@@ -848,5 +910,13 @@ export declare class CharacterItemEquipmentInfoDto extends base.CharacterItemEqu
848
910
  * Whether the equipment is expired
849
911
  */
850
912
  isExpired: boolean | null;
913
+ /**
914
+ * Freestyle Coupon application status (0:not applied, 1:applied)
915
+ */
916
+ freestyleFlag: string | null;
851
917
  constructor(obj: CharacterItemEquipmentInfoBody);
918
+ /**
919
+ * Freestyle Coupon application status
920
+ */
921
+ get isFreestyleFlag(): boolean;
852
922
  }
@@ -0,0 +1,56 @@
1
+ import * as base from '../../../common/dto/union/unionChampion';
2
+ import { UnionChampionBadgeInfoBody, UnionChampionBody, UnionChampionInfoBody } from '../../response/union/unionChampionBody';
3
+ /**
4
+ * Union Champion information
5
+ */
6
+ export declare class UnionChampionDto extends base.UnionChampionDto {
7
+ /**
8
+ * Reference date for query (SGT, daily data with hours and minutes set to 0)
9
+ */
10
+ date: Date | null;
11
+ /**
12
+ * Union Champion information
13
+ */
14
+ unionChampion: UnionChampionInfoDto[];
15
+ /**
16
+ * Champion Insignia effects
17
+ */
18
+ championBadgeTotalInfo: UnionChampionBadgeInfoDto[];
19
+ constructor(obj: UnionChampionBody);
20
+ }
21
+ /**
22
+ * Champion Insignia effects
23
+ */
24
+ export declare class UnionChampionBadgeInfoDto extends base.UnionChampionBadgeInfoDto {
25
+ /**
26
+ * Union Champion Insignia effects
27
+ */
28
+ stat: string;
29
+ constructor(obj: UnionChampionBadgeInfoBody);
30
+ }
31
+ /**
32
+ * Union Champion information
33
+ */
34
+ export declare class UnionChampionInfoDto extends base.UnionChampionInfoDto {
35
+ /**
36
+ * Union Champion character name
37
+ */
38
+ championName: string;
39
+ /**
40
+ * Union Champion slot
41
+ */
42
+ championSlot: number;
43
+ /**
44
+ * Union Champion level
45
+ */
46
+ championGrade: string;
47
+ /**
48
+ * Union Champion character's job
49
+ */
50
+ championClass: string;
51
+ /**
52
+ * Union Champion Insignia information
53
+ */
54
+ championBadgeInfo: UnionChampionBadgeInfoDto[];
55
+ constructor(obj: UnionChampionInfoBody);
56
+ }
@@ -24,4 +24,5 @@ export * from './dto/guild/guild';
24
24
  export * from './dto/guild/guildBasic';
25
25
  export * from './dto/union/union';
26
26
  export * from './dto/union/unionArtifact';
27
+ export * from './dto/union/unionChampion';
27
28
  export * from './dto/union/unionRaider';
@@ -23,6 +23,7 @@ import { GuildDto } from './dto/guild/guild';
23
23
  import { GuildBasicDto } from './dto/guild/guildBasic';
24
24
  import { UnionDto } from './dto/union/union';
25
25
  import { UnionArtifactDto } from './dto/union/unionArtifact';
26
+ import { UnionChampionDto } from './dto/union/unionChampion';
26
27
  import { UnionRaiderDto } from './dto/union/unionRaider';
27
28
  import { CharacterImageAction, CharacterImageEmotion, CharacterImageWeaponMotion } from '../common/enum/characterImage';
28
29
  import { DateOptions } from '../common/mapleStoryApi';
@@ -300,6 +301,17 @@ export declare class MapleStoryApi extends base.MapleStoryApi {
300
301
  * @param dateOptions Reference date for query (SGT)
301
302
  */
302
303
  getUnionArtifact(ocid: string, dateOptions?: DateOptions): Promise<UnionArtifactDto | null>;
304
+ /**
305
+ * Retrieves Union Champion information.
306
+ * - MapleStory game data can be verified approximately 15 minutes after updates.
307
+ * - Data is available starting from December 18, 2025.
308
+ * - Historical data can be queried by specifying the desired date, and data from the previous day can be accessed starting at 2 AM the next day. (For example, when querying data for December 22, data from 00:00 to 24:00 on December 22 will be retrieved.)
309
+ * - Due to game content changes, the ocid may be updated. Please pay attention to this when updating services based on ocid.
310
+ * - This API provides data for MapleStory SEA.
311
+ * @param ocid Character identifier
312
+ * @param dateOptions Reference date for query (SGT)
313
+ */
314
+ getUnionChampion(ocid: string, dateOptions?: DateOptions): Promise<UnionChampionDto | null>;
303
315
  /**
304
316
  * Retrieves information for the guild identifier (oguild_id).
305
317
  * - MapleStory game data can be verified approximately 15 minutes after updates.
@@ -23,12 +23,14 @@ export type CharacterAndroidEquipmentHairBody = {
23
23
  base_color: string | null;
24
24
  mix_color: string | null;
25
25
  mix_rate: string;
26
+ freestyle_flag: string | null;
26
27
  };
27
28
  export type CharacterAndroidEquipmentFaceBody = {
28
29
  face_name: string | null;
29
30
  base_color: string | null;
30
31
  mix_color: string | null;
31
32
  mix_rate: string;
33
+ freestyle_flag: string | null;
32
34
  };
33
35
  export type CharacterAndroidEquipmentSkinBody = {
34
36
  skin_name: string;
@@ -63,6 +65,7 @@ export type CharacterAndroidCashItemEquipmentBody = {
63
65
  cash_item_label: string | null;
64
66
  cash_item_coloring_prism: CharacterAndroidCashItemEquipmentColoringPrismBody | null;
65
67
  android_item_gender: string | null;
68
+ freestyle_flag: string | null;
66
69
  };
67
70
  export type CharacterAndroidCashItemEquipmentOptionBody = {
68
71
  option_type: string;
@@ -12,5 +12,5 @@ export type CharacterBasicBody = {
12
12
  character_image: string;
13
13
  character_date_create: string | null;
14
14
  access_flag: 'true' | 'false';
15
- liberation_quest_clear_flag: 'true' | 'false';
15
+ liberation_quest_clear: string;
16
16
  };
@@ -14,12 +14,14 @@ export type CharacterBeautyEquipmentHairBody = {
14
14
  base_color: string;
15
15
  mix_color: string | null;
16
16
  mix_rate: string;
17
+ freestyle_flag: string | null;
17
18
  };
18
19
  export type CharacterBeautyEquipmentFaceBody = {
19
20
  face_name: string;
20
21
  base_color: string;
21
22
  mix_color: string | null;
22
23
  mix_rate: string;
24
+ freestyle_flag: string | null;
23
25
  };
24
26
  export type CharacterBeautyEquipmentSkinBody = {
25
27
  skin_name: string;
@@ -25,6 +25,8 @@ export type CharacterCashItemEquipmentPresetBody = {
25
25
  cash_item_label: string | null;
26
26
  cash_item_coloring_prism: CharacterCashItemEquipmentColoringPrismBody | null;
27
27
  item_gender: string | null;
28
+ skills: string[];
29
+ freestyle_flag: string | null;
28
30
  };
29
31
  export type CharacterCashItemEquipmentOptionBody = {
30
32
  option_type: string;
@@ -8,6 +8,7 @@ export type CharacterItemEquipmentBody = {
8
8
  item_equipment_preset_2: CharacterItemEquipmentInfoBody[] | null;
9
9
  item_equipment_preset_3: CharacterItemEquipmentInfoBody[] | null;
10
10
  title: CharacterItemEquipmentTitleBody | null;
11
+ medal_shape: CharacterItemEquipmentMedalShapeBody | null;
11
12
  dragon_equipment: CharacterItemEquipmentDragonInfoBody[];
12
13
  mechanic_equipment: CharacterItemEquipmentMechanicInfoBody[];
13
14
  };
@@ -50,6 +51,7 @@ export type CharacterItemEquipmentInfoBody = {
50
51
  item_starforce_option: CharacterItemEquipmentStarforceOptionBody;
51
52
  special_ring_level: number;
52
53
  date_expire: string | null;
54
+ freestyle_flag: string | null;
53
55
  };
54
56
  export type CharacterItemEquipmentMechanicInfoBody = {
55
57
  item_equipment_part: string;
@@ -80,6 +82,7 @@ export type CharacterItemEquipmentMechanicInfoBody = {
80
82
  item_starforce_option: CharacterItemEquipmentOptionBody;
81
83
  special_ring_level: number;
82
84
  date_expire: string | null;
85
+ freestyle_flag: string | null;
83
86
  };
84
87
  export type CharacterItemEquipmentDragonInfoBody = CharacterItemEquipmentMechanicInfoBody;
85
88
  export type CharacterItemEquipmentOptionBody = {
@@ -189,4 +192,15 @@ export type CharacterItemEquipmentTitleBody = {
189
192
  title_description: string | null;
190
193
  date_expire: string | null;
191
194
  date_option_expire: string | null;
195
+ title_shape_name: string | null;
196
+ title_shape_icon: string | null;
197
+ title_shape_description: string | null;
198
+ };
199
+ export type CharacterItemEquipmentMedalShapeBody = {
200
+ medal_shape_name: string;
201
+ medal_shape_icon: string;
202
+ medal_shape_description: string;
203
+ medal_shape_changed_name: string;
204
+ medal_shape_changed_icon: string;
205
+ medal_shape_changed_description: string;
192
206
  };
@@ -0,0 +1,15 @@
1
+ export type UnionChampionBody = {
2
+ date: string;
3
+ union_champion: UnionChampionInfoBody[];
4
+ champion_badge_total_info: UnionChampionBadgeInfoBody[];
5
+ };
6
+ export type UnionChampionInfoBody = {
7
+ champion_name: string;
8
+ champion_slot: number;
9
+ champion_grade: string;
10
+ champion_class: string;
11
+ champion_badge_info: UnionChampionBadgeInfoBody[];
12
+ };
13
+ export type UnionChampionBadgeInfoBody = {
14
+ stat: string;
15
+ };
@@ -98,7 +98,15 @@ export declare class CharacterAndroidEquipmentFaceDto extends base.CharacterAndr
98
98
  * 機器人臉型混染顏色比例
99
99
  */
100
100
  mixRate: string;
101
+ /**
102
+ * 自由造型券 使用狀態(0:未使用,1:已使用)
103
+ */
104
+ freestyleFlag: string | null;
101
105
  constructor(obj: CharacterAndroidEquipmentFaceBody);
106
+ /**
107
+ * 自由造型券 使用狀態
108
+ */
109
+ get isFreestyleFlag(): boolean;
102
110
  }
103
111
  /**
104
112
  * 機器人髮型資訊
@@ -120,7 +128,15 @@ export declare class CharacterAndroidEquipmentHairDto extends base.CharacterAndr
120
128
  * 機器人髮型混染顏色比例
121
129
  */
122
130
  mixRate: string;
131
+ /**
132
+ * 自由造型券 使用狀態(0:未使用,1:已使用)
133
+ */
134
+ freestyleFlag: string | null;
123
135
  constructor(obj: CharacterAndroidEquipmentHairBody);
136
+ /**
137
+ * 自由造型券 使用狀態
138
+ */
139
+ get isFreestyleFlag(): boolean;
124
140
  }
125
141
  /**
126
142
  * 機器人膚色資訊
@@ -295,5 +311,13 @@ export declare class CharacterAndroidCashItemEquipmentDto extends base.Character
295
311
  * 道具可裝備性別
296
312
  */
297
313
  androidItemGender: string | null;
314
+ /**
315
+ * 自由造型券 使用狀態(0:未使用,1:已使用)
316
+ */
317
+ freestyleFlag: string | null;
298
318
  constructor(obj: CharacterAndroidCashItemEquipmentBody);
319
+ /**
320
+ * 自由造型券 使用狀態
321
+ */
322
+ get isFreestyleFlag(): boolean;
299
323
  }
@@ -57,7 +57,7 @@ export declare class CharacterBasicDto extends base.CharacterBasicDto {
57
57
  */
58
58
  accessFlag: 'true' | 'false';
59
59
  /**
60
- * 解放任務完成狀態 (0:未完成,1:創世武器已解放)
60
+ * 解放任務完成狀態 (0:未完成,1:創世武器已解放, 2:命運武器第一階段解放)
61
61
  */
62
62
  liberationQuestClear: string;
63
63
  constructor(obj: CharacterBasicBody);
@@ -65,7 +65,15 @@ export declare class CharacterBeautyEquipmentFaceDto extends base.CharacterBeaut
65
65
  * 臉型混染顏色比例
66
66
  */
67
67
  mixRate: string;
68
+ /**
69
+ * 自由造型券 使用狀態(0:未使用,1:已使用)
70
+ */
71
+ freestyleFlag: string | null;
68
72
  constructor(obj: CharacterBeautyEquipmentFaceBody);
73
+ /**
74
+ * 自由造型券 使用狀態
75
+ */
76
+ get isFreestyleFlag(): boolean;
69
77
  }
70
78
  /**
71
79
  * 角色髮型資訊
@@ -87,7 +95,15 @@ export declare class CharacterBeautyEquipmentHairDto extends base.CharacterBeaut
87
95
  * 髮型混染顏色比例
88
96
  */
89
97
  mixRate: string;
98
+ /**
99
+ * 自由造型券 使用狀態(0:未使用,1:已使用)
100
+ */
101
+ freestyleFlag: string | null;
90
102
  constructor(obj: CharacterBeautyEquipmentHairBody);
103
+ /**
104
+ * 自由造型券 使用狀態
105
+ */
106
+ get isFreestyleFlag(): boolean;
91
107
  }
92
108
  /**
93
109
  * 角色膚色資訊
@@ -154,5 +154,13 @@ export declare class CharacterCashItemEquipmentPresetDto extends base.CharacterC
154
154
  * 技能名稱
155
155
  */
156
156
  skills: string[];
157
+ /**
158
+ * 自由造型券 使用狀態(0:未使用,1:已使用)
159
+ */
160
+ freestyleFlag: string | null;
157
161
  constructor(obj: CharacterCashItemEquipmentPresetBody);
162
+ /**
163
+ * 自由造型券 使用狀態
164
+ */
165
+ get isFreestyleFlag(): boolean;
158
166
  }