Class EmailTemplateClient

이메일 템플릿 클라이언트

이메일 템플릿 및 카테고리 관리 기능을 제공합니다. 템플릿을 사용하면 자주 사용하는 메일 형식을 저장하고 재사용할 수 있으며, 카테고리를 통해 템플릿을 체계적으로 분류하고 관리할 수 있습니다.

Example

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

// 카테고리 생성
const category = await client.createCategory("client-1", {
  categoryName: "마케팅",
  categoryDesc: "마케팅 관련 이메일 템플릿"
});

// 템플릿 생성
const template = await client.createTemplate("client-1", {
  categoryId: category.categoryId,
  templateId: "welcome-email",
  templateName: "환영 이메일",
  sendMailAddress: "noreply@example.com",
  title: "##name##님, 환영합니다!",
  body: "<p>가입을 축하드립니다.</p>"
});

Constructors

constructor

new EmailTemplateClient(
credentials: AwesomeMessageCredentials,
): EmailTemplateClient
이메일 템플릿 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns EmailTemplateClient
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

listTemplates

listTemplates(
externalId: string,
query?: ListEmailTemplatesRequest,
): Promise<ListEmailTemplatesResponse>
템플릿 목록을 조회합니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- Optionalquery: ListEmailTemplatesRequest
 조회 조건
Returns Promise<ListEmailTemplatesResponse>
템플릿 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listTemplates("client-1", {
 categoryId: 1,
 useYn: "Y",
 pageNum: 1,
 pageSize: 15
});
```

getTemplate

getTemplate(
externalId: string,
templateId: string,
): Promise<GetEmailTemplateResponse>
템플릿 상세를 조회합니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- templateId: string
 템플릿 ID
Returns Promise<GetEmailTemplateResponse>
템플릿 상세 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
NotFoundException 해당 템플릿을 찾을 수 없는 경우

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

createTemplate

createTemplate(
externalId: string,
request: CreateEmailTemplateRequest,
): Promise<void>
템플릿을 생성합니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- request: CreateEmailTemplateRequest
 템플릿 생성 요청 데이터
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.createTemplate("client-1", {
 categoryId: 1,
 templateId: "order-confirm",
 templateName: "주문 확인",
 sendMailAddress: "order@example.com",
 title: "주문이 완료되었습니다",
 body: "주문번호: ##orderNo##",
 templateType: "DEFAULT"
});
```

updateTemplate

updateTemplate(
 externalId: string,
 templateId: string,
 request: UpdateEmailTemplateRequest,
): Promise<void>
템플릿을 수정합니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- templateId: string
 템플릿 ID
- request: UpdateEmailTemplateRequest
 템플릿 수정 요청 데이터
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
NotFoundException 해당 템플릿을 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.updateTemplate("client-1", "order-confirm", {
 templateName: "주문 확인 (수정)",
 body: "주문번호: ##orderNo##감사합니다."
});
```

deleteTemplate

deleteTemplate(externalId: string, templateId: string): Promise<void>
템플릿을 삭제합니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- templateId: string
 템플릿 ID
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
NotFoundException 해당 템플릿을 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.deleteTemplate("client-1", "order-confirm");
```

uploadTemplateAttachment

uploadTemplateAttachment(
externalId: string,
request: UploadEmailTemplateAttachmentRequest,
): Promise<UploadEmailTemplateAttachmentResponse>
템플릿 첨부 파일을 업로드합니다.

템플릿에 사용할 첨부 파일을 업로드합니다. 업로드된 파일 ID를 템플릿 생성/수정 시 attachFileIdList에 포함시킵니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- request: UploadEmailTemplateAttachmentRequest
 첨부 파일 업로드 요청 데이터
Returns Promise<UploadEmailTemplateAttachmentResponse>
업로드된 파일 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const fileBuffer = fs.readFileSync("logo.png");
const result = await client.uploadTemplateAttachment("client-1", {
 fileName: "logo.png",
 fileBody: fileBuffer
});
// result.fileId를 템플릿 생성 시 사용
```

listCategories(
externalId: string,
query?: ListEmailCategoriesRequest,
): Promise<ListEmailCategoriesResponse>
카테고리 목록을 조회합니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- Optionalquery: ListEmailCategoriesRequest
 조회 조건
Returns Promise<ListEmailCategoriesResponse>
카테고리 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listCategories("client-1", {
 useYn: "Y",
 pageNum: 1,
 pageSize: 15
});
```

getCategory

getCategory(
externalId: string,
categoryId: string,
): Promise<GetEmailCategoryResponse>
카테고리 상세를 조회합니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- categoryId: string
 카테고리 ID
Returns Promise<GetEmailCategoryResponse>
카테고리 상세 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
NotFoundException 해당 카테고리를 찾을 수 없는 경우

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

createCategory

createCategory(
externalId: string,
request: CreateEmailCategoryRequest,
): Promise<CreateEmailCategoryResponse>
카테고리를 생성합니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- request: CreateEmailCategoryRequest
 카테고리 생성 요청 데이터
Returns Promise<CreateEmailCategoryResponse>
생성된 카테고리 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.createCategory("client-1", {
 categoryName: "거래 알림",
 categoryDesc: "주문, 배송 등 거래 관련 알림",
 useYn: "Y"
});
```

updateCategory

updateCategory(
 externalId: string,
 categoryId: number,
 request: UpdateEmailCategoryRequest,
): Promise<void>
카테고리를 수정합니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- categoryId: number
 카테고리 ID
- request: UpdateEmailCategoryRequest
 카테고리 수정 요청 데이터
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
NotFoundException 해당 카테고리를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.updateCategory("client-1", 123, {
 categoryName: "거래 알림 (수정)",
 useYn: "Y"
});
```

deleteCategory

deleteCategory(externalId: string, categoryId: number): Promise<void>
카테고리를 삭제합니다.
Parameters
- externalId: string
 클라이언트 연동 ID
- categoryId: number
 카테고리 ID
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
NotFoundException 해당 카테고리를 찾을 수 없는 경우

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

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class EmailTemplateClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns EmailTemplateClient

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>

listTemplates

Parameters

Returns Promise<ListEmailTemplatesResponse>

Throws

Throws

Throws

Example

getTemplate

Parameters

Returns Promise<GetEmailTemplateResponse>

Throws

Throws

Throws

Throws

Example

createTemplate

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

updateTemplate

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Example

deleteTemplate

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Example

uploadTemplateAttachment

Parameters

Returns Promise<UploadEmailTemplateAttachmentResponse>

Throws

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody

`Protected`credentials