Class EmailReservationClient

이메일 예약 클라이언트

이메일 예약 발송 조회 및 취소 기능을 제공합니다. 예약된 메일의 목록 조회, 상세 조회, 취소 등의 기능을 포함합니다.

Example

const client = new EmailReservationClient({ accessKeyId, secretAccessKey });

// 예약 목록 조회
const reservations = await client.listReservations("client-1", {
  startSendDate: "2024-01-01 00:00:00",
  endSendDate: "2024-01-31 23:59:59"
});

// 예약 취소
await client.cancelByRequestId("client-1", "request-123");

Index

Constructors

constructor

new EmailReservationClient(
credentials: AwesomeMessageCredentials,
): EmailReservationClient
이메일 예약 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns EmailReservationClient
Overrides BaseClient.constructor

Methods

`Protected`createSendHeaders

createSendHeaders(options?: SendOptions): Record<string, string>
SendOptions에서 HTTP 헤더를 생성합니다
Parameters
- Optionaloptions: SendOptions
  발송 옵션
Returns Record<string, string>
생성된 헤더 객체

Inherited from BaseClient.createSendHeaders

`Protected`get

get<T>(path: string, headers?: Record<string, string>): Promise<T>
GET 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.get

`Protected`post

post<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
POST 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.post

`Protected`postFormData

postFormData<T>(
    path: string,
    formData: FormData,
    headers?: Record<string, string>,
): Promise<T>
FormData를 사용한 POST 요청 (multipart/form-data)
Type Parameters
- T
Parameters
- path: string
  API 경로
- formData: FormData
  undici의 FormData 객체
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.postFormData

`Protected`put

put<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
PUT 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.put

`Protected`delete

delete<T>(path: string, headers?: Record<string, string>): Promise<T>
DELETE 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.delete

`Protected`deleteWithBody

deleteWithBody<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
DELETE 요청 (body 포함)
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.deleteWithBody

listReservations

listReservations(
externalId: string,
query?: ListEmailReservationsRequest,
): Promise<ListEmailReservationsResponse>
예약 발송 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListEmailReservationsRequest
  조회 조건
Returns Promise<ListEmailReservationsResponse>
예약 발송 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listReservations("client-1", {
  startSendDate: "2024-01-01 00:00:00",
  endSendDate: "2024-01-31 23:59:59",
  senderMail: "sender@example.com",
  pageNum: 1,
  pageSize: 15
});
```

getReservation

getReservation(
    externalId: string,
    requestId: string,
    mailSeq: number,
): Promise<GetEmailReservationResponse>
예약 발송 상세를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- requestId: string
  요청 ID
- mailSeq: number
  메일 시퀀스
Returns Promise<GetEmailReservationResponse>
예약 발송 상세 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 예약을 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.getReservation("client-1", "request-123", 1);
```

cancelByRequestId

cancelByRequestId(
    externalId: string,
    requestId: string,
    updateUser?: string,
): Promise<void>
요청 ID로 예약 발송을 취소합니다.

해당 요청 ID의 모든 예약 메일을 취소합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- requestId: string
  요청 ID
- OptionalupdateUser: string
  수정 유저 (선택)
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 예약을 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.cancelByRequestId("client-1", "request-123", "admin");
```

cancelByRecipient

cancelByRecipient(
    externalId: string,
    requestId: string,
    mailSequence: number,
    updateUser?: string,
): Promise<void>
수신자별로 예약 발송을 취소합니다.

특정 요청 ID의 특정 수신자에 대한 예약 메일만 취소합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- requestId: string
  요청 ID
- mailSequence: number
  메일 시퀀스
- OptionalupdateUser: string
  수정 유저 (선택)
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 예약을 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.cancelByRecipient("client-1", "request-123", 1, "admin");
```

cancelByFilter

cancelByFilter(
externalId: string,
request: CancelEmailReservationsByFilterRequest,
): Promise<CancelEmailReservationResponse>
필터 조건으로 예약 발송을 일괄 취소합니다.

검색 조건에 맞는 모든 예약 메일을 취소합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CancelEmailReservationsByFilterRequest
  취소 요청 데이터
Returns Promise<CancelEmailReservationResponse>
취소 결과 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.cancelByFilter("client-1", {
  searchParameter: {
    startSendDate: "2024-01-01 00:00:00",
    endSendDate: "2024-01-31 23:59:59",
    senderMail: "sender@example.com"
  },
  updateUser: "admin"
});
```

listCancelRequests

listCancelRequests(
externalId: string,
query?: ListEmailCancelReservationsRequest,
): Promise<ListEmailCancelReservationsResponse>
예약 취소 요청 목록을 조회합니다.

다중 필터로 취소 요청한 내역을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListEmailCancelReservationsRequest
  조회 조건
Returns Promise<ListEmailCancelReservationsResponse>
예약 취소 요청 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listCancelRequests("client-1", {
  startRequestedDateTime: "2024-01-01 00:00:00",
  endRequestedDateTime: "2024-01-31 23:59:59",
  pageNum: 1,
  pageSize: 15
});
```

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class EmailReservationClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns EmailReservationClient

Methods

ProtectedcreateSendHeaders

Parameters

Returns Record<string, string>

Protectedget

Type Parameters

Parameters

Returns Promise<T>

Protectedpost

Type Parameters

Parameters

Returns Promise<T>

ProtectedpostFormData

Type Parameters

Parameters

Returns Promise<T>

Protectedput

Type Parameters

Parameters

Returns Promise<T>

Protecteddelete

Type Parameters

Parameters

Returns Promise<T>

ProtecteddeleteWithBody

Type Parameters

Parameters

Returns Promise<T>

listReservations

Parameters

Returns Promise<ListEmailReservationsResponse>

Throws

Throws

Throws

Example

getReservation

Parameters

Returns Promise<GetEmailReservationResponse>

Throws

Throws

Throws

Throws

Example

cancelByRequestId

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Example

cancelByRecipient

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Example

cancelByFilter

Parameters

Returns Promise<CancelEmailReservationResponse>

Throws

Throws

Throws

Example

listCancelRequests

Parameters

Returns Promise<ListEmailCancelReservationsResponse>

Throws

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody

`Protected`credentials