[Change] Change kakao channels, templates request type

Palbahngmiyine · Palbahngmiyine · commit 34a9a77e0c0b · 2022-09-30T15:53:24.000+09:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "solapi",
-  "version": "5.1.2",
+  "version": "5.1.3",
   "description": "SOLAPI SDK for Node.js(Server Side Only)",
   "repository": {
     "type": "git",
diff --git a/src/models/kakao/kakaoAlimtalkTemplate.ts b/src/models/kakao/kakaoAlimtalkTemplate.ts
@@ -1,19 +1,20 @@
 import {KakaoButton} from './kakaoButton';
+import {KakaoAlimtalkTemplateStatus} from '../../types/commonTypes';
 
 /**
- * 카카오 알림톡 템플릿 메시지 유형
+ * @description 카카오 알림톡 템플릿 메시지 유형
  * BA:기본형, EX:부가정보형, AD:광고추가형, MI: 복합형
  */
 export type KakaoAlimtalkTemplateMessageType = 'BA' | 'EX' | 'AD' | 'MI'
 
 /**
- * 카카오 알림톡 템플릿 강조 유형
+ * @description 카카오 알림톡 템플릿 강조 유형
  * NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형
  */
 export type KakaoAlimtalkTemplateEmphasizeType = 'NONE' | 'TEXT' | 'IMAGE'
 
 /**
- * 카카오 알림톡 템플릿 그룹 유형(기본값은 Channel)
+ * @description 카카오 알림톡 템플릿 그룹 유형(기본값은 Channel)
  */
 type KakaoAlimtalkTemplateAssignType = 'CHANNEL' | 'GROUP'
 
@@ -25,7 +26,7 @@ type KakaoAlimtalkTemplateCommentType = {
 }
 
 type KakaoAlimtalkTemplateCodeType = {
-    status: 'PENDING' | 'INSPECTING' | 'REJECTED' | 'APPROVED'
+    status: Omit<KakaoAlimtalkTemplateStatus, 'DELETED'>
     comments: Array<KakaoAlimtalkTemplateCommentType>
 }
 
@@ -113,7 +114,7 @@ export class KakaoAlimtalkTemplate {
     /**
      * 카카오 알림톡 템플릿 상태 현황목록
      */
-    codes: Array<KakaoAlimtalkTemplateCodeType>;
+    codes: Array<KakaoAlimtalkTemplateCodeType> | null;
 
     /**
      * 알림톡 템플릿 생성일자
diff --git a/src/requests/messageRequest.ts b/src/requests/messageRequest.ts
@@ -1,5 +1,5 @@
 import {Message, MessageType} from '../models/message';
-import {GroupId, OperatorType} from '../types/commonTypes';
+import {DateOperatorType, GroupId, KakaoAlimtalkTemplateStatus} from '../types/commonTypes';
 import {formatISO} from 'date-fns';
 import stringDateTransfer from '../lib/stringDateTrasnfer';
 import {KakaoButton} from '../models/kakao/kakaoButton';
@@ -13,7 +13,7 @@ export type DefaultAgentType = {
     osPlatform: string
 };
 
-const sdkVersion = 'nodejs/5.1.2';
+const sdkVersion = 'nodejs/5.1.3';
 
 export const defaultAgent: DefaultAgentType = {
     sdkVersion,
@@ -197,15 +197,23 @@ export type CreateGroupRequest = DefaultAgentType & {
     appId?: string
 }
 
+/**
+ * @description GET API 중 일부 파라미터 조회 시 필요한 객체
+ * @see https://docs.solapi.com/api-reference/overview#operator
+ */
+export type DatePayloadType = {
+    [key in DateOperatorType]?: string | Date;
+};
+
 export type GetKakaoChannelsRequest = {
-    channelId: string;
-    searchId: string;
-    phoneNumber: string;
-    categoryCode: string;
-    dateCreated: Record<keyof Omit<OperatorType, 'ne' | 'like' | 'in'>, string>;
-    dateUpdated: Record<keyof Omit<OperatorType, 'ne' | 'like' | 'in'>, string>;
-    startKey: string;
-    limit: number;
+    channelId: string
+    searchId: string
+    phoneNumber: string
+    categoryCode: string
+    dateCreated: DatePayloadType
+    dateUpdated: DatePayloadType
+    startKey: string
+    limit: number
 }
 
 export type CreateKakaoChannelTokenRequest = {
@@ -220,48 +228,43 @@ export type CreateKakaoChannelRequest = {
     token: string
 }
 
-export type GetKakaoAlimtalkTemplatesRequestType = {
-    name?: string
-    pfId?: string
-    templateId?: string
-    isHidden?: boolean
-    status?: string
-    startKey?: string
-    limit?: number
-    dateCreated?: string
-    dateUpdated?: string
-}
-
-export class GetKakaoAlimtalkTemplatesRequest {
-    'name[like]'?: string;
-    pfId?: string;
-    templateId?: string;
-    isHidden?: boolean;
-    status?: string;
-    startKey?: string;
-    limit?: number;
-    'dateCreated[gte]'?: string;
-    'dateUpdated[gte]'?: string;
-
-    constructor(getKakaoAlimtalkTemplatesRequestType: GetKakaoAlimtalkTemplatesRequestType) {
-        this['name[like]'] = getKakaoAlimtalkTemplatesRequestType.name;
-        this.pfId = getKakaoAlimtalkTemplatesRequestType.pfId;
-        this.templateId = getKakaoAlimtalkTemplatesRequestType.templateId;
-        this.isHidden = getKakaoAlimtalkTemplatesRequestType.isHidden;
-        this.status = getKakaoAlimtalkTemplatesRequestType.status;
-        this.startKey = getKakaoAlimtalkTemplatesRequestType.startKey;
-        this.limit = getKakaoAlimtalkTemplatesRequestType.limit;
-        this['dateCreated[gte]'] = getKakaoAlimtalkTemplatesRequestType.dateCreated;
-        this['dateUpdated[gte]'] = getKakaoAlimtalkTemplatesRequestType.dateUpdated;
-    }
+/**
+ * @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 = {
+    name: string
+    channelId: string
+    templateId: string
+    isHidden: boolean
+    status: KakaoAlimtalkTemplateStatus
+    startKey: string
+    limit: number
+    dateCreated: DatePayloadType
+    dateUpdated: DatePayloadType
 }
 
 /**
- * @description 카카오 알림톡 템플릿 요청 파라미터 타입
- * @param name 알림톡 템플릿 제목 (동일한 채널에 중복적인 이름 등록 불가)
- * @property content 알림톡 템플릿 내용
- * @property categoryCode 알림톡 템플릿 카테고리 코드, KakaoAlimtalkTemplateCategory 타입 참고
- * @property buttons 알림톡 템플릿
+ * @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 = {
     name?: string;
@@ -271,13 +274,18 @@ export type KakaoAlimtalkTemplateRequest = {
     messageType?: KakaoAlimtalkTemplateMessageType;
     emphasizeType?: KakaoAlimtalkTemplateEmphasizeType;
     extra?: string;
-    ad?: string;
     emphasizeTitle?: string;
     emphasizeSubtitle?: string;
     securityFlag?: boolean;
     imageId?: string;
 };
 
+/**
+ * @description 카카오 알림톡 템플릿 생성 요청 타입
+ * @see {KakaoAlimtalkTemplateRequest}
+ * @param {string|undefined} channelId - 카카오 비즈니스 채널 ID
+ * @param {string|undefined} channelGroupId - 카카오 비즈니스 채널 그룹 ID
+ */
 export type CreateKakaoAlimtalkTemplateRequest = KakaoAlimtalkTemplateRequest & {
     channelId?: string;
     channelGroupId?: string;
diff --git a/src/solapi.ts b/src/solapi.ts
@@ -10,7 +10,6 @@ import {
     GetGroupMessagesRequest,
     GetGroupsRequest,
     GetKakaoAlimtalkTemplatesRequest,
-    GetKakaoAlimtalkTemplatesRequestType,
     GetKakaoChannelsRequest,
     GetMessagesRequest,
     GetMessagesRequestType,
@@ -42,7 +41,7 @@ import {
     RequestKakaoChannelTokenResponse,
     SingleMessageSentResponse
 } from './responses/messageResponses';
-import {GroupId} from './types/commonTypes';
+import {DateOperatorType, GroupId} from './types/commonTypes';
 import queryParameterGenerator from './lib/queryParameterGenerator';
 import {formatISO} from 'date-fns';
 import ImageToBase64 from 'image-to-base64';
@@ -377,7 +376,36 @@ export class SolapiMessageService {
      * @param data 카카오 채널 목록을 더 자세하게 조회할 때 필요한 파라미터
      */
     async getKakaoChannels(data?: Partial<GetKakaoChannelsRequest>): Promise<GetKakaoChannelsResponse> {
-        const parameter = qs.stringify(data, {indices: false});
+        const payload = data;
+        if (payload?.dateCreated && typeof payload?.dateCreated != 'undefined') {
+            const dateCreatedPayload = payload.dateCreated;
+            Object.keys(dateCreatedPayload).forEach((key) => {
+                const dateKey = key as DateOperatorType;
+                const dateCreated = dateCreatedPayload[dateKey];
+                if (dateCreated) {
+                    const formattedDateCreated = formatISO(stringDateTransfer(dateCreated));
+                    if (payload.dateCreated) {
+                        payload.dateCreated[dateKey] = formattedDateCreated;
+                    }
+                }
+            });
+        }
+
+        if (data?.dateUpdated && typeof payload?.dateUpdated != 'undefined') {
+            const dateUpdatedPayload = payload.dateUpdated;
+            Object.keys(dateUpdatedPayload).forEach(key => {
+                const dateKey = key as DateOperatorType;
+                const dateUpdated = dateUpdatedPayload[dateKey];
+                if (dateUpdated) {
+                    const formattedDateUpdated = formatISO(stringDateTransfer(dateUpdated));
+                    if (payload.dateUpdated) {
+                        payload.dateUpdated[dateKey] = formattedDateUpdated;
+                    }
+                }
+            });
+        }
+
+        const parameter = qs.stringify(payload, {indices: false});
         const endpoint = `${this.baseUrl}/kakao/v2/channels?${parameter}`;
         const requestConfig: RequestConfig = {
             method: 'GET',
@@ -437,10 +465,39 @@ export class SolapiMessageService {
      * 카카오 템플릿 목록 조회
      * @param data 카카오 템플릿 목록을 더 자세하게 조회할 때 필요한 파라미터
      */
-    async getKakaoAlimtalkTemplates(data?: GetKakaoAlimtalkTemplatesRequestType): Promise<GetKakaoAlimtalkTemplatesResponse> {
-        const parameter: GetKakaoAlimtalkTemplatesRequest | object = data ? new GetKakaoAlimtalkTemplatesRequest(data) : {};
-        const endpoint = queryParameterGenerator(`${this.baseUrl}/kakao/v2/templates`, parameter);
+    async getKakaoAlimtalkTemplates(data?: Partial<GetKakaoAlimtalkTemplatesRequest>): Promise<GetKakaoAlimtalkTemplatesResponse> {
+        // TODO: need to eliminate duplicate code
+        const payload = data;
+        if (payload?.dateCreated && typeof payload?.dateCreated != 'undefined') {
+            const dateCreatedPayload = payload.dateCreated;
+            Object.keys(dateCreatedPayload).forEach((key) => {
+                const dateKey = key as DateOperatorType;
+                const dateCreated = dateCreatedPayload[dateKey];
+                if (dateCreated) {
+                    const formattedDateCreated = formatISO(stringDateTransfer(dateCreated));
+                    if (payload.dateCreated) {
+                        payload.dateCreated[dateKey] = formattedDateCreated;
+                    }
+                }
+            });
+        }
+
+        if (data?.dateUpdated && typeof payload?.dateUpdated != 'undefined') {
+            const dateUpdatedPayload = payload.dateUpdated;
+            Object.keys(dateUpdatedPayload).forEach(key => {
+                const dateKey = key as DateOperatorType;
+                const dateUpdated = dateUpdatedPayload[dateKey];
+                if (dateUpdated) {
+                    const formattedDateUpdated = formatISO(stringDateTransfer(dateUpdated));
+                    if (payload.dateUpdated) {
+                        payload.dateUpdated[dateKey] = formattedDateUpdated;
+                    }
+                }
+            });
+        }
 
+        const parameter = qs.stringify(payload, {indices: false});
+        const endpoint = `${this.baseUrl}/kakao/v2/templates?${parameter}`;
         const requestConfig: RequestConfig = {
             method: 'GET',
             url: endpoint
@@ -531,6 +588,6 @@ export class SolapiMessageService {
             method: 'DELETE',
             url: `${this.baseUrl}/kakao/v2/templates/${templateId}`
         };
-        return defaultFetcher<unknown, KakaoAlimtalkTemplate>(this.authInfo, requestConfig, {});
+        return defaultFetcher<never, KakaoAlimtalkTemplate>(this.authInfo, requestConfig);
     }
 }
diff --git a/src/types/commonTypes.ts b/src/types/commonTypes.ts
@@ -88,6 +88,24 @@ export type Group = {
 
 
 /**
+ * @description 검색 조건 파라미터
  * @see https://docs.solapi.com/api-reference/overview#operator
  */
 export type OperatorType = 'eq' | 'gte' | 'lte' | 'ne' | 'in' | 'like' | 'gt' | 'lt'
+
+/**
+ * @description 검색 조건 파라미터
+ * @see https://docs.solapi.com/api-reference/overview#operator
+ */
+export type DateOperatorType = 'eq' | 'gte' | 'lte' | 'gt' | 'lt'
+
+/**
+ * @description 카카오 알림톡 템플릿 상태
+ * PENDING - 대기
+ * INSPECTING - 검수중
+ * APPROVED - 등록완료(검수완료)
+ * REJECTED - 반려됨
+ * DELETED - 삭제됨
+ */
+export type KakaoAlimtalkTemplateStatus = 'PENDING' | 'INSPECTING' | 'APPROVED' |
+    'REJECTED' | 'DELETED'

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "solapi",`
`3`		`- "version": "5.1.2",`
	`3`	`+ "version": "5.1.3",`
`4`	`4`	`"description": "SOLAPI SDK for Node.js(Server Side Only)",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`