Merge pull request #54 from hotsoycandy/feature/update-5.2.1

Feature/update 5.2.1

Author: hotsoycandy

README.md

@@ -3,7 +3,7 @@
 
 
 You can send text messages(SMS, LMS, MMS), Kakao friendtalk(include notification friendtalk) in Korea using this
-package.  
+package.
 This package is 100% compatible with SOLAPI family services (Purple Book, Nurigo, etc.).
 
 ## Installing
@@ -40,4 +40,4 @@ environment and OS you’re using. Please include a stack trace and reduced repr
 Licensed under the MIT License.
 
 
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsolapi%2Fsolapi-nodejs.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsolapi%2Fsolapi-nodejs?ref=badge_large)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsolapi%2Fsolapi-nodejs.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsolapi%2Fsolapi-nodejs?ref=badge_large)

changelog/ko/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 5.2.1 (2023년 1월 25일)
+
+- 080 수신 거부 목록을 조회할 수 있는 기능을 추가했습니다.
+  - 예제가 추가되었습니다.
+- 코드 안정화가 진행되었습니다.
+  - 그룹 조회 시 검색 조건이 제대로 작동하지 않는 부분을 안정화 했습니다.
+
 # 5.2.0 (2022년 12월 13일)
 
 - 5.1.1에서 추가된 카카오 알림톡 채널/템플릿 관리 기능을 안정화 했습니다.

examples/javascript/common/src/iam/get_blacks.js

@@ -0,0 +1,27 @@
+/**
+ * 080 수신 거부 목록 조회
+ */
+const {SolapiMessageService} = require('solapi');
+const messageService = new SolapiMessageService(
+  'ENTER_YOUR_API_KEY',
+  'ENTER_YOUR_API_SECRET',
+);
+
+messageService.getBlacks({
+  // 차단 당한 발신번호를 검색하는 경우
+  // senderNumber: '029302266',
+
+  // 날짜로 검색하는 경우
+  // startDate: '2022-12-01 00:00:00', // Date 객체로도 요청 가능
+  // endDate: '2022-12-31 23:59:59' // Date 객체로도 요청 가능
+}).then(res => {
+  // 목록
+  console.log('#page1', res.blackList);
+
+  // 응답에 nextKeyr가 있을 경우 다음 페이지도 조회 가능
+  messageService.getBlacks({
+    startKey: res.nextKey
+  }).then(res => {
+    console.log('#page2', res.blackList);
+  });
+});

package.json

@@ -1,6 +1,6 @@
 {
   "name": "solapi",
-  "version": "5.2.0",
+  "version": "5.2.1",
   "description": "SOLAPI SDK for Node.js(Server Side Only)",
   "repository": {
     "type": "git",

src/requests/getBlacksRequest.ts

@@ -0,0 +1,43 @@
+import {formatWithTransfer} from '../lib/stringDateTrasnfer';
+import { DatePayloadType } from './messageRequest';
+
+export interface GetBlacksRequest {
+  senderNumber?: string;
+  startKey?: string;
+  limit?: number;
+  /**
+ * @description 조회할 시작 날짜
+ */
+  startDate?: string | Date;
+
+  /**
+   * @description 조회할 종료 날짜
+   */
+  endDate?: string | Date;
+}
+
+export class GetBlacksFinalizeRequest implements GetBlacksRequest {
+  type = 'DENIAL' as const;
+  senderNumber?: string;
+  startKey?: string;
+  limit?: number;
+  dateCreated?: DatePayloadType;
+
+  constructor(parameter: GetBlacksRequest) {
+    this.type = 'DENIAL';
+    this.senderNumber = parameter.senderNumber;
+    this.startKey = parameter.startKey;
+    this.limit = parameter.limit;
+
+    if (parameter.startDate != undefined) {
+      this.dateCreated = Object.assign(this.dateCreated ?? {}, {
+        gte: formatWithTransfer(parameter.startDate),
+      });
+    }
+    if (parameter.endDate != undefined) {
+      this.dateCreated = Object.assign(this.dateCreated ?? {}, {
+        lte: formatWithTransfer(parameter.endDate),
+      });
+    }
+  }
+}

src/responses/getBlacksResponse.ts

@@ -0,0 +1,11 @@
+import {
+  HandleKey,
+  Black,
+} from '../types/commonTypes';
+
+export type GetBlacksResponse = {
+  startKey: string | null | undefined;
+  limit: number;
+  nextKey: string | null | undefined;
+  blackList: Record<HandleKey, Black>;
+};

src/solapi.ts

@@ -29,6 +29,7 @@ import {
   RequestKakaoChannelTokenResponse,
   SingleMessageSentResponse,
 } from './responses/messageResponses';
+import { GetBlacksResponse } from './responses/getBlacksResponse';
 import {GroupId} from './types/commonTypes';
 import {formatISO} from 'date-fns';
 import ImageToBase64 from 'image-to-base64';
@@ -70,6 +71,10 @@ import {
   GetGroupsFinalizeRequest,
   GetGroupsRequest,
 } from './requests/messages/groups/getGroupsRequest';
+import {
+  GetBlacksFinalizeRequest,
+  GetBlacksRequest,
+} from './requests/getBlacksRequest';
 import {
   GetMessagesRequest,
   GetMessagesFinalizeRequest,
@@ -343,7 +348,7 @@ export class SolapiMessageService {
   async getGroups(data?: GetGroupsRequest) {
     let payload: GetGroupsFinalizeRequest = {};
     if (data) {
-      payload = new GetGroupsFinalizeRequest(payload);
+      payload = new GetGroupsFinalizeRequest(data);
     }
     const parameter = qs.stringify(payload, {
       indices: false,
@@ -849,4 +854,29 @@ export class SolapiMessageService {
 
     return new KakaoAlimtalkTemplate(response);
   }
+
+  /**
+   * 080 수신 거부 조회
+   * @param data 080 수신 거부 상세 조회용 request 데이터
+   * @returns GetBlacksResponse
+   */
+  async getBlacks(data?: GetBlacksRequest): Promise<GetBlacksResponse> {
+    let payload: GetBlacksFinalizeRequest = { type: 'DENIAL' };
+    if (data) {
+      payload = new GetBlacksFinalizeRequest(data);
+    }
+    const parameter = qs.stringify(payload, {
+      indices: false,
+      addQueryPrefix: true,
+    });
+    const endpoint = `${this.baseUrl}/iam/v1/black${parameter}`;
+    const requestConfig: RequestConfig = {
+      method: 'GET',
+      url: endpoint,
+    };
+    return defaultFetcher<never, GetBlacksResponse>(
+      this.authInfo,
+      requestConfig,
+    );
+  }
 }

src/types/commonTypes.ts

@@ -86,6 +86,17 @@ export type Group = {
   dateUpdated: string;
 };
 
+export type HandleKey = string;
+
+export type Black = {
+  handleKey: HandleKey;
+  type: 'DENIAL';
+  senderNumber: string;
+  recipientNumber: string
+  dateCreated: string;
+  dateUpdated: string
+}
+
 /**
  * @description 검색 조건 파라미터
  * @see https://docs.solapi.com/api-reference/overview#operator