[Fix] fix wrong annotations

Author: Palbahngmiyine

src/models/kakao/kakaoAlimtalkTemplate.ts

@@ -2,13 +2,13 @@ import {KakaoButton} from './kakaoButton';
 import {KakaoAlimtalkTemplateStatus} from '../../types/commonTypes';
 
 /**
- * @description 카카오 알림톡 템플릿 메시지 유형
+ * @description 카카오 알림톡 템플릿 메시지 유형<br>
  * BA:기본형, EX:부가정보형, AD:광고추가형, MI: 복합형
  */
 export type KakaoAlimtalkTemplateMessageType = 'BA' | 'EX' | 'AD' | 'MI'
 
 /**
- * @description 카카오 알림톡 템플릿 강조 유형
+ * @description 카카오 알림톡 템플릿 강조 유형<br>
  * NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형
  */
 export type KakaoAlimtalkTemplateEmphasizeType = 'NONE' | 'TEXT' | 'IMAGE'
@@ -31,7 +31,7 @@ type KakaoAlimtalkTemplateCodeType = {
 }
 
 /**
- * 카카오 알림톡 템플릿 모델
+ * @description 카카오 알림톡 템플릿 모델<br>
  * 알림톡 템플릿 자체의 정보는 아래 페이지를 참고해보세요!
  * @see https://kakaobusiness.gitbook.io/main/ad/bizmessage/notice-friend/content-guide
  */

src/requests/messageRequest.ts

@@ -230,61 +230,101 @@ export type CreateKakaoChannelRequest = {
 
 /**
  * @description 카카오 알림톡 조회를 위한 요청 타입
- * @param {string} name - 알림톡 템플릿 제목
- * @param {string} channelId - 카카오 비즈니스 채널 ID
- * @param {string} templateId - 카카오 알림톡 템플릿 ID
- * @param {boolean} isHidden - 숨긴 템플릿 여부 확인
- * @param {KakaoAlimtalkTemplateStatus} status - 알림톡 템플릿 상태
- * @param {string} startKey - 페이지네이션 조회 키
- * @param {number} limit - 조회 시 제한할 건 수 (기본: 20, 최대: 500)
- * @param {DatePayloadType} dateCreated - 생성일자 (조회 조건 -> eq, lte, gte 등이 포함되어야 함)
- * @param {DatePayloadType} dateUpdated - 수정일자 (조회 조건 -> eq, lte, gte 등이 포함되어야 함)
  */
 export type GetKakaoAlimtalkTemplatesRequest = {
+    /**
+     * @description 알림톡 템플릿 제목
+     */
     name: string
+    /**
+     * @description 카카오 비즈니스 채널 ID
+     */
     channelId: string
+    /**
+     * @description 카카오 알림톡 템플릿 ID
+     */
     templateId: string
+    /**
+     * @description 숨긴 템플릿 여부 확인
+     */
     isHidden: boolean
+    /**
+     * @description 알림톡 템플릿 상태
+     */
     status: KakaoAlimtalkTemplateStatus
+    /**
+     * @description 페이지네이션 조회 키
+     */
     startKey: string
+    /**
+     * @description 조회 시 제한할 건 수 (기본: 20, 최대: 500)
+     */
     limit: number
+    /**
+     * @description 생성일자 (조회 조건 -> eq, lte, gte 등이 포함되어야 함)
+     */
     dateCreated: DatePayloadType
+    /**
+     * @description 수정일자 (조회 조건 -> eq, lte, gte 등이 포함되어야 함)
+     */
     dateUpdated: DatePayloadType
 }
 
 /**
  * @description 카카오 알림톡 템플릿 요청 타입
- * @param {string|undefined} name - 알림톡 템플릿 제목 (동일한 채널에 중복적인 이름 등록 불가)
- * @param {string|undefined} content - 알림톡 템플릿 내용
- * @param {string|undefined} categoryCode - 알림톡 템플릿 카테고리 코드, KakaoAlimtalkTemplateCategory 타입 참고
- * @param {KakaoButton[]|undefined} buttons - 알림톡 템플릿 버튼 목록
- * @param {KakaoAlimtalkTemplateMessageType|undefined} messageType - 알림톡 템플릿 메시지 유형
- * @param {KakaoAlimtalkTemplateEmphasizeType|undefined} emphasizeType - 카카오 알림톡 템플릿 강조 유형
- * @param {string|undefined} extra - 부가정보, 치환문구를 넣을 수 없음
- * @param {string|undefined} emphasizeTitle - 강조 표기 제목 (강조 표기형 유형만 등록 가능)
- * @param {string|undefined} emphasizeSubTitle - 강조 표기 부제목 (강조 표기형 유형만 등록 가능)
- * @param {boolean|undefined} securityFlag - 보안 템플릿 여부
- * @param {string|undefined} imageId - 알림톡 템플릿 내에 업로드 할 이미지 ID (Storage API 사용 필요)
  */
 export type KakaoAlimtalkTemplateRequest = {
+    /**
+     * @description 알림톡 템플릿 제목
+     */
     name?: string;
+    /**
+     * @description 알림톡 템플릿 내용
+     */
     content?: string;
+    /**
+     * @description 알림톡 템플릿 카테고리 코드, KakaoAlimtalkTemplateCategory 타입 참고
+     */
     categoryCode?: string;
+    /**
+     * @description 알림톡 템플릿 버튼 배열
+     */
     buttons?: Array<KakaoButton>;
+    /**
+     * @description 알림톡 템플릿 메시지 유형
+     */
     messageType?: KakaoAlimtalkTemplateMessageType;
+    /**
+     * @description 카카오 알림톡 템플릿 강조 유형
+     */
     emphasizeType?: KakaoAlimtalkTemplateEmphasizeType;
+    /**
+     * @description 부가정보, 치환문구를 넣을 수 없음
+     */
     extra?: string;
+    /**
+     * @description 강조 표기 제목 (강조 표기형 유형만 등록 가능)
+     */
     emphasizeTitle?: string;
+    /**
+     * @description 강조 표기 부제목 (강조 표기형 유형만 등록 가능)
+     */
     emphasizeSubtitle?: string;
+    /**
+     * @description 보안 템플릿 여부
+     */
     securityFlag?: boolean;
+    /**
+     * @description 알림톡 템플릿 내에 업로드 할 이미지 ID (Storage API 사용 필요)
+     */
     imageId?: string;
 };
 
 /**
  * @description 카카오 알림톡 템플릿 생성 요청 타입
- * @see {KakaoAlimtalkTemplateRequest}
- * @param {string|undefined} channelId - 카카오 비즈니스 채널 ID
- * @param {string|undefined} channelGroupId - 카카오 비즈니스 채널 그룹 ID
+ * @see {@link KakaoAlimtalkTemplateRequest}
+ * @param channelId - 카카오 비즈니스 채널 ID
+ * @param channelGroupId - 카카오 비즈니스 채널 그룹 ID
  */
 export type CreateKakaoAlimtalkTemplateRequest = KakaoAlimtalkTemplateRequest & {
     channelId?: string;

src/types/commonTypes.ts

@@ -100,11 +100,11 @@ export type OperatorType = 'eq' | 'gte' | 'lte' | 'ne' | 'in' | 'like' | 'gt' |
 export type DateOperatorType = 'eq' | 'gte' | 'lte' | 'gt' | 'lt'
 
 /**
- * @description 카카오 알림톡 템플릿 상태
- * PENDING - 대기
- * INSPECTING - 검수중
- * APPROVED - 등록완료(검수완료)
- * REJECTED - 반려됨
+ * @description 카카오 알림톡 템플릿 상태<br><br>
+ * PENDING - 대기<br><br>
+ * INSPECTING - 검수중<br><br>
+ * APPROVED - 등록완료(검수완료)<br><br>
+ * REJECTED - 반려됨<br><br>
  * DELETED - 삭제됨
  */
 export type KakaoAlimtalkTemplateStatus = 'PENDING' | 'INSPECTING' | 'APPROVED' |