Merge pull request #58 from hotsoycandy/feature/update-5.2.3

getBlockNumbers 추가, getBlockGroups 그룹 조건 추가

Author: hotsoycandy

changelog/ko/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 5.2.3 (2023년 2월 3일)
+
+- 수신 차단 그룹 별 수신번호 목록을 조회하실 수 있는 기능을 추가했습니다.
+  - 예제가 추가되었습니다.
+- 그룹 수신 차단 목록에 조회할 수 있는 항목 수가 늘어났습니다.
+  - 각 검색 조건에 대한 예제와 설명이 추가되었습니다.
+
 # 5.2.2 (2023년 2월 3일)
 
 - 그룹 수신 차단 목록을 조회할 수 있는 기능을 추가했습니다.

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

@@ -9,7 +9,10 @@ const messageService = new SolapiMessageService(
 
 messageService.getBlockGroups({
   // 해당 그룹이 켜져있는지 아닌지 확인하고 싶을 경우
-  // status: 'ACTIVE' // 'ACTIVE' 혹은 'INACTIVE'
+  // status: 'ACTIVE' // 'ACTIVE' 혹은 'INACTIVE',
+
+  // 해당 그룹의 대한 이름을 검색해보고 싶을 경우
+  // name: '070번호그룹' (부분 검색 가능)
 }).then(res => {
   // 목록
   console.log('#page1', res.blockGroups);

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

@@ -0,0 +1,26 @@
+/**
+ * 080 수신 거부 목록 조회
+ */
+const {SolapiMessageService} = require('solapi');
+const messageService = new SolapiMessageService(
+  'ENTER_YOUR_API_KEY',
+  'ENTER_YOUR_API_SECRET',
+);
+
+messageService.getBlockNumbers({
+  // 수신 차단한 수신번호를 검색해보고 싶을 경우
+  // phoneNumber: '01000000000',
+
+  // 차단할 때 남긴 메모를 검색해보고 싶을 경우
+  // memo: '이벤트 발송' (부분 검색 가능)
+}).then(res => {
+  // 목록
+  console.log('#page1', res.blockNumbers);
+
+  // 응답에 nextKey가 있을 경우 다음 페이지도 조회 가능
+  messageService.getBlockNumbers({
+    startKey: res.nextKey
+  }).then(res => {
+    console.log('#page2', res.blockNumbers);
+  });
+});

package.json

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

src/requests/getBlockGroupsRequest.ts

@@ -1,10 +1,22 @@
-import {formatWithTransfer} from '../lib/stringDateTrasnfer';
-import { DatePayloadType } from './messageRequest';
+import {formatWithTransfer} from '../../lib/stringDateTrasnfer';
+import { DatePayloadType } from '../messageRequest';
 
 export interface GetBlacksRequest {
+  /**
+   * @description 080 수신거부를 요청한 수신번호
+   */
   senderNumber?: string;
+
+  /**
+   * @description 페이지네이션 조회 키
+  */
   startKey?: string;
+
+  /**
+   * @description 조회 시 제한할 건 수 (기본: 20, 최대: 500)
+   */
   limit?: number;
+
   /**
  * @description 조회할 시작 날짜
  */

src/requests/getBlacksRequest.ts src/requests/iam/getBlacksRequest.tssrc/requests/getBlacksRequest.ts renamed to src/requests/iam/getBlacksRequest.ts

@@ -0,0 +1,64 @@
+export interface GetBlockGroupsRequest {
+  /**
+   * @description 수신 거부 그룹 핸들키
+   */
+  blockGroupId?: string;
+
+  /**
+   * @description 수신 거부 그룹에 등록된 모든 발신번호 적용 여부.
+   */
+  useAll?: boolean;
+
+  /**
+   * @description 수신 거부 그룹에 등록된 발신번호
+   */
+  senderNumber?: string;
+
+  /**
+   * @description 수신 거부 그룹 이름 (부분 검색 가능)
+   */
+  name?: { like: string } | string;
+
+  /**
+   * @description 수신 거부 그룹 활성화 상태
+   */
+  status?: 'ACTIVE' | 'INACTIVE';
+
+  /**
+   * @description 페이지네이션 조회 키
+   */
+  startKey?: string;
+
+  /**
+   * @description 조회 시 제한할 건 수 (기본: 20, 최대: 500)
+   */
+  limit?: number;
+}
+
+export class GetBlockGroupsFinalizeRequest implements GetBlockGroupsRequest {
+  blockGroupId?: string;
+  useAll?: boolean;
+  senderNumber?: string;
+  name?: { like: string } | string;
+  status?: 'ACTIVE' | 'INACTIVE';
+  startKey?: string;
+  limit?: number;
+
+  constructor(parameter: GetBlockGroupsRequest) {
+    this.blockGroupId = parameter.blockGroupId;
+    this.useAll = parameter.useAll;
+    this.senderNumber = parameter.senderNumber;
+    if (parameter.name != undefined) {
+      if (typeof parameter.name == 'string') {
+        this.name = {
+          like: parameter.name,
+        };
+      } else {
+        this.name = parameter.name;
+      }
+    }
+    this.status = parameter.status;
+    this.startKey = parameter.startKey;
+    this.limit = parameter.limit;
+  }
+}

src/requests/iam/getBlockGroupsRequest.ts

@@ -0,0 +1,57 @@
+export interface GetBlockNumbersRequest {
+  /**
+   * @description 수신 차단 그룹 별 수신번호 핸들키
+   */
+  blockNumberId?: string;
+
+  /**
+   * @description 해당 그룹의 발신번호를 차단한 수신번호
+   */
+  phoneNumber?: string;
+
+  /**
+   * @description 수신 차단 그룹 핸들키
+   */
+  blockGroupId?: string;
+
+  /**
+   * @description 수신 차단 그룹 별 수신번호 목록에 대한 메모 (부분 검색 가능)
+   */
+  memo?: { like: string } | string;
+
+  /**
+   * @description 페이지네이션 조회 키
+   */
+  startKey?: string;
+
+  /**
+   * @description 조회 시 제한할 건 수 (기본: 20, 최대: 500)
+   */
+  limit?: number;
+}
+
+export class GetBlockNumbersFinalizeRequest implements GetBlockNumbersRequest {
+  blockNumberId?: string;
+  phoneNumber?: string;
+  blockGroupId?: string;
+  memo?: { like: string } | string;
+  startKey?: string;
+  limit?: number;
+
+  constructor(parameter: GetBlockNumbersRequest) {
+    this.blockNumberId = parameter.blockNumberId;
+    this.phoneNumber = parameter.phoneNumber;
+    this.blockGroupId = parameter.blockGroupId;
+    if (parameter.memo != undefined) {
+      if (typeof parameter.memo == 'string') {
+        this.memo = {
+          like: parameter.memo,
+        };
+      } else {
+        this.memo = parameter.memo;
+      }
+    }
+    this.startKey = parameter.startKey;
+    this.limit = parameter.limit;
+  }
+}

src/requests/iam/getBlockNumbersRequest.ts

@@ -1,7 +1,7 @@
 import {
   HandleKey,
   Black,
-} from '../types/commonTypes';
+} from '../../types/commonTypes';
 
 export type GetBlacksResponse = {
   startKey: string | null | undefined;

src/responses/getBlacksResponse.ts src/responses/iam/getBlacksResponse.tssrc/responses/getBlacksResponse.ts renamed to src/responses/iam/getBlacksResponse.ts

@@ -1,11 +1,10 @@
 import {
-  BlockGroupId,
   BlockGroup
-} from '../types/commonTypes';
+} from '../../types/commonTypes';
 
 export type GetBlockGroupsResponse = {
   startKey: string | null | undefined;
   limit: number;
   nextKey: string | null | undefined;
-  blockGroups: Record<BlockGroupId, BlockGroup>;
+  blockGroups: BlockGroup[];
 };