Skip to content

Commit 7a5b81c

Browse files
Remove deprecated methods and Update annotations in solapi.ts:
* remove sendMany, sendManyFuture
1 parent 8fd43e8 commit 7a5b81c

1 file changed

Lines changed: 21 additions & 62 deletions

File tree

src/solapi.ts

Lines changed: 21 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import {
99
GetGroupMessagesRequest,
1010
GroupMessageAddRequest,
1111
MultipleDetailMessageSendingRequest,
12-
MultipleMessageSendingRequest,
1312
RemoveMessageIdsToGroupRequest,
1413
RequestConfig,
1514
ScheduledDateSendingRequest,
@@ -29,9 +28,9 @@ import {
2928
RequestKakaoChannelTokenResponse,
3029
SingleMessageSentResponse,
3130
} from './responses/messageResponses';
32-
import { GetBlacksResponse } from './responses/iam/getBlacksResponse';
33-
import { GetBlockGroupsResponse } from './responses/iam/getBlockGroupsResponse';
34-
import { GetBlockNumbersResponse } from './responses/iam/getBlockNumbersResponse';
31+
import {GetBlacksResponse} from './responses/iam/getBlacksResponse';
32+
import {GetBlockGroupsResponse} from './responses/iam/getBlockGroupsResponse';
33+
import {GetBlockNumbersResponse} from './responses/iam/getBlockNumbersResponse';
3534
import {GroupId} from './types/commonTypes';
3635
import {formatISO} from 'date-fns';
3736
import ImageToBase64 from 'image-to-base64';
@@ -79,11 +78,11 @@ import {
7978
} from './requests/iam/getBlacksRequest';
8079
import {
8180
GetBlockGroupsFinalizeRequest,
82-
GetBlockGroupsRequest
81+
GetBlockGroupsRequest,
8382
} from './requests/iam/getBlockGroupsRequest';
8483
import {
8584
GetBlockNumbersFinalizeRequest,
86-
GetBlockNumbersRequest
85+
GetBlockNumbersRequest,
8786
} from './requests/iam/getBlockNumbersRequest';
8887
import {
8988
GetMessagesRequest,
@@ -101,6 +100,7 @@ export * from './errors/defaultError';
101100
* 발송 및 조회 등 SOLAPI에서 제공되는 여러 API의 기능을 쉽게 사용할 수 있습니다.
102101
* SOLAPI 자체의 서비스에 관한 사항은 SOLAPI 홈페이지를 참고해주세요.
103102
* @see https://solapi.github.io/solapi-nodejs
103+
* @see https://developers.solapi.com/category/nodejs
104104
*/
105105
export class SolapiMessageService {
106106
private readonly baseUrl = 'https://api.solapi.com';
@@ -117,7 +117,7 @@ export class SolapiMessageService {
117117
}
118118

119119
/**
120-
* 메시지 발송 기능, sendMany 함수에서 조금 더 개선된 오류 표시 기능등을 제공합니다.
120+
* 메시지 발송 기능, sendMany 함수보다 개선된 오류 표시 기능등을 제공합니다.
121121
* 한번의 요청으로 최대 10,000건까지 발송할 수 있습니다.
122122
* @param messages 발송 요청할 메시지 파라미터(문자, 알림톡 등)
123123
* @param requestConfigParameter request시 필요한 파라미터 오브젝트
@@ -192,6 +192,7 @@ export class SolapiMessageService {
192192

193193
/**
194194
* 단일 메시지 예약 발송 기능
195+
* @deprecated 해당 함수는 더이상 지원하지 않습니다, send 메소드를 사용하세요!
195196
* @param message 메시지(문자, 알림톡 등)
196197
* @param scheduledDate 예약일시
197198
*/
@@ -205,58 +206,11 @@ export class SolapiMessageService {
205206
return this.reserveGroup(groupId, scheduledDate);
206207
}
207208

208-
/**
209-
* @deprecated 이 기능은 더이상 사용되지 않습니다. send 메소드를 이용하세요!
210-
* 여러 메시지 즉시 발송 기능
211-
* 한번 요청으로 최대 10,000건의 메시지를 추가할 수 있습니다.
212-
* @param messages 여러 메시지(문자, 알림톡 등)
213-
* @param allowDuplicates 중복 수신번호 허용
214-
* @param appId appstore용 app id
215-
*/
216-
async sendMany(
217-
messages: Array<Message>,
218-
allowDuplicates = false,
219-
appId?: string,
220-
): Promise<GroupMessageResponse> {
221-
const parameter = new MultipleMessageSendingRequest(
222-
messages,
223-
allowDuplicates,
224-
appId,
225-
);
226-
const requestConfig: RequestConfig = {
227-
method: 'POST',
228-
url: `${this.baseUrl}/messages/v4/send-many`,
229-
};
230-
return defaultFetcher<MultipleMessageSendingRequest, GroupMessageResponse>(
231-
this.authInfo,
232-
requestConfig,
233-
parameter,
234-
);
235-
}
236-
237-
/**
238-
* @deprecated 이 기능은 더이상 사용되지 않습니다. send 메소드를 이용하세요!
239-
* 여러 메시지 예약 발송 기능
240-
* 한번 요청으로 최대 10,000건의 메시지를 추가할 수 있습니다.
241-
* @param messages 여러 메시지(문자, 알림톡 등)
242-
* @param scheduledDate 예약 발송 일자
243-
* @param allowDuplicates 중복 수신번호 허용
244-
* @param appId appstore용 app id
245-
*/
246-
async sendManyFuture(
247-
messages: Array<Message>,
248-
scheduledDate: string | Date,
249-
allowDuplicates = false,
250-
appId?: string,
251-
): Promise<GroupMessageResponse> {
252-
const groupId = await this.createGroup(allowDuplicates, appId);
253-
await this.addMessagesToGroup(groupId, messages);
254-
scheduledDate = stringDateTransfer(scheduledDate);
255-
return this.reserveGroup(groupId, scheduledDate);
256-
}
257-
258209
/**
259210
* 그룹 생성
211+
* @param allowDuplicates 생성할 그룹이 중복 수신번호를 허용하는지 여부를 확인합니다.
212+
* @param appId 생성할 그룹에 특정 appId를 넣을 수 있습니다.
213+
* @param customFields 생성할 그룹에 사용자 정의 데이터를 Record 형태로 삽입할 수 있습니다.
260214
*/
261215
async createGroup(
262216
allowDuplicates?: boolean,
@@ -285,6 +239,7 @@ export class SolapiMessageService {
285239
/**
286240
* 그룹 메시지 추가
287241
* 한번 요청으로 최대 10,000건의 메시지를 추가할 수 있습니다.
242+
* 추가 가능한 최대 메시지 건 수는 1,000,000건 입니다.
288243
* @param groupId 생성 된 Group ID
289244
* @param messages 여러 메시지(문자, 알림톡 등)
290245
*/
@@ -873,7 +828,7 @@ export class SolapiMessageService {
873828
* @returns GetBlacksResponse
874829
*/
875830
async getBlacks(data?: GetBlacksRequest): Promise<GetBlacksResponse> {
876-
let payload: GetBlacksFinalizeRequest = { type: 'DENIAL' };
831+
let payload: GetBlacksFinalizeRequest = {type: 'DENIAL'};
877832
if (data) {
878833
payload = new GetBlacksFinalizeRequest(data);
879834
}
@@ -897,8 +852,10 @@ export class SolapiMessageService {
897852
* @param data 수신 거부 그룹 조회용 request 데이터
898853
* @returns GetBlockGroupsResponse
899854
*/
900-
async getBlockGroups(data?: GetBlockGroupsRequest): Promise<GetBlockGroupsResponse> {
901-
let payload: GetBlockGroupsFinalizeRequest = { };
855+
async getBlockGroups(
856+
data?: GetBlockGroupsRequest,
857+
): Promise<GetBlockGroupsResponse> {
858+
let payload: GetBlockGroupsFinalizeRequest = {};
902859
if (data) {
903860
payload = new GetBlockGroupsFinalizeRequest(data);
904861
}
@@ -922,8 +879,10 @@ export class SolapiMessageService {
922879
* @param data 수신 거부 그룹 별 수신번호 조회용 request 데이터
923880
* @returns GetBlockNumbersResponse
924881
*/
925-
async getBlockNumbers(data?: GetBlockNumbersRequest): Promise<GetBlockNumbersResponse> {
926-
let payload: GetBlockNumbersFinalizeRequest = { };
882+
async getBlockNumbers(
883+
data?: GetBlockNumbersRequest,
884+
): Promise<GetBlockNumbersResponse> {
885+
let payload: GetBlockNumbersFinalizeRequest = {};
927886
if (data) {
928887
payload = new GetBlockNumbersFinalizeRequest(data);
929888
}

0 commit comments

Comments
 (0)