Merge pull request #55 from hotsoycandy/feature/update-5.2.2

feature/update-5.2.2

Author: hotsoycandy

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

@@ -0,0 +1,23 @@
+/**
+ * 080 수신 거부 목록 조회
+ */
+const {SolapiMessageService} = require('solapi');
+const messageService = new SolapiMessageService(
+  'ENTER_YOUR_API_KEY',
+  'ENTER_YOUR_API_SECRET',
+);
+
+messageService.getBlockGroups({
+  // 해당 그룹이 켜져있는지 아닌지 확인하고 싶을 경우
+  // status: 'ACTIVE' // 'ACTIVE' 혹은 'INACTIVE'
+}).then(res => {
+  // 목록
+  console.log('#page1', res.blockGroups);
+
+  // 응답에 nextKey가 있을 경우 다음 페이지도 조회 가능
+  messageService.getBlockGroups({
+    startKey: res.nextKey
+  }).then(res => {
+    console.log('#page2', res.blockGroups);
+  });
+});

package.json

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

src/requests/getBlockGroupsRequest.ts

@@ -0,0 +1,17 @@
+export interface GetBlockGroupsRequest {
+  status?: 'ACTIVE' | 'INACTIVE';
+  startKey?: string;
+  limit?: number;
+}
+
+export class GetBlockGroupsFinalizeRequest implements GetBlockGroupsRequest {
+  status?: 'ACTIVE' | 'INACTIVE';
+  startKey?: string;
+  limit?: number;
+
+  constructor(parameter: GetBlockGroupsRequest) {
+    this.status = parameter.status;
+    this.startKey = parameter.startKey;
+    this.limit = parameter.limit;
+  }
+}

src/responses/getBlockGroupsResponse.ts

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

src/solapi.ts

@@ -30,6 +30,7 @@ import {
   SingleMessageSentResponse,
 } from './responses/messageResponses';
 import { GetBlacksResponse } from './responses/getBlacksResponse';
+import { GetBlockGroupsResponse } from './responses/getBlockGroupsResponse';
 import {GroupId} from './types/commonTypes';
 import {formatISO} from 'date-fns';
 import ImageToBase64 from 'image-to-base64';
@@ -75,6 +76,10 @@ import {
   GetBlacksFinalizeRequest,
   GetBlacksRequest,
 } from './requests/getBlacksRequest';
+import {
+  GetBlockGroupsFinalizeRequest,
+  GetBlockGroupsRequest
+} from './requests/getBlockGroupsRequest';
 import {
   GetMessagesRequest,
   GetMessagesFinalizeRequest,
@@ -879,4 +884,29 @@ export class SolapiMessageService {
       requestConfig,
     );
   }
+
+  /**
+   * 수신 거부 그룹 조회
+   * @param data 수신 거부 그룹 조회용 request 데이터
+   * @returns GetBlockGroupsResponse
+   */
+  async getBlockGroups(data?: GetBlockGroupsRequest): Promise<GetBlockGroupsResponse> {
+    let payload: GetBlockGroupsFinalizeRequest = { };
+    if (data) {
+      payload = new GetBlockGroupsFinalizeRequest(data);
+    }
+    const parameter = qs.stringify(payload, {
+      indices: false,
+      addQueryPrefix: true,
+    });
+    const endpoint = `${this.baseUrl}/iam/v1/block/groups${parameter}`;
+    const requestConfig: RequestConfig = {
+      method: 'GET',
+      url: endpoint,
+    };
+    return defaultFetcher<never, GetBlockGroupsResponse>(
+      this.authInfo,
+      requestConfig,
+    );
+  }
 }

src/types/commonTypes.ts

@@ -97,6 +97,19 @@ export type Black = {
   dateUpdated: string
 }
 
+export type BlockGroupId = string;
+
+export type BlockGroup = {
+  blockGroupId: BlockGroupId;
+  accountId: string;
+  status: 'INACTIVE' | 'ACTIVE';
+  name: string;
+  useAll: boolean;
+  senderNumbers: string[]
+  dateCreated: string;
+  dateUpdated: string;
+}
+
 /**
  * @description 검색 조건 파라미터
  * @see https://docs.solapi.com/api-reference/overview#operator