Class default

Hierarchy (View Summary)

default
- default

Index

Constructors

Methods

cancelInspectionKakaoAlimtalkTemplate createKakaoAlimtalkTemplate getKakaoAlimtalkTemplate getKakaoAlimtalkTemplateCategories getKakaoAlimtalkTemplates getWithQuery removeKakaoAlimtalkTemplate request requestEffect updateKakaoAlimtalkTemplate updateKakaoAlimtalkTemplateName

Constructors

constructor

new default(apiKey: string, apiSecret: string): default
Parameters
- apiKey: string
- apiSecret: string
Returns default
Inherited from default.constructor
- Defined in src/services/defaultService.ts:44

Methods

cancelInspectionKakaoAlimtalkTemplate

cancelInspectionKakaoAlimtalkTemplate(
templateId: string,
): Promise<KakaoAlimtalkTemplate>
카카오 알림톡 템플릿 검수 취소 요청
Parameters
- templateId: string
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/services/kakao/templates/kakaoTemplateService.ts:140

createKakaoAlimtalkTemplate

createKakaoAlimtalkTemplate(
    data:
        | {
            buttons?: readonly (
                | {
                    buttonName: string;
                    buttonType: "WL";
                    linkMo: string;
                    linkPc?: string
                    | null;
                }
                | {
                    buttonName: string;
                    buttonType: "AL";
                    linkAnd: string;
                    linkIos: string;
                }
                | {
                    buttonName: string;
                    buttonType: "AC"
                    | "BK"
                    | "MD"
                    | "BC"
                    | "BT"
                    | "DS";
                }
            )[];
            categoryCode: string;
            content: string;
            emphasizeSubTitle?: string;
            emphasizeTitle?: string;
            emphasizeType?: "TEXT"
            | "IMAGE"
            | "NONE"
            | "ITEM_LIST";
            extra?: string;
            header?: string;
            highlight?: {
                description?: string | null;
                imageId?: string | null;
                title?: string | null;
            };
            imageId?: string;
            item?: {
                list: readonly { description: string; title: string }[];
                summary: { description?: string | null; title?: string | null };
            };
            messageType?: "BA"
            | "EX"
            | "AD"
            | "MI";
            name: string;
            quickReplies?: readonly (
                | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                | { linkType: "BK" | "BC" | "BT"; name: string }
            )[];
            securityFlag?: boolean;
        } & { channelId: string }
        | {
            buttons?: readonly (
                | {
                    buttonName: string;
                    buttonType: "WL";
                    linkMo: string;
                    linkPc?: string
                    | null;
                }
                | {
                    buttonName: string;
                    buttonType: "AL";
                    linkAnd: string;
                    linkIos: string;
                }
                | {
                    buttonName: string;
                    buttonType: "AC"
                    | "BK"
                    | "MD"
                    | "BC"
                    | "BT"
                    | "DS";
                }
            )[];
            categoryCode: string;
            content: string;
            emphasizeSubTitle?: string;
            emphasizeTitle?: string;
            emphasizeType?: "TEXT"
            | "IMAGE"
            | "NONE"
            | "ITEM_LIST";
            extra?: string;
            header?: string;
            highlight?: {
                description?: string | null;
                imageId?: string | null;
                title?: string | null;
            };
            imageId?: string;
            item?: {
                list: readonly { description: string; title: string }[];
                summary: { description?: string | null; title?: string | null };
            };
            messageType?: "BA"
            | "EX"
            | "AD"
            | "MI";
            name: string;
            quickReplies?: readonly (
                | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                | { linkType: "BK" | "BC" | "BT"; name: string }
            )[];
            securityFlag?: boolean;
        } & { channelGroupId: string },
): Promise<KakaoAlimtalkTemplate>
Parameters
- data:
      | {
          buttons?: readonly (
              | {
                  buttonName: string;
                  buttonType: "WL";
                  linkMo: string;
                  linkPc?: string
                  | null;
              }
              | {
                  buttonName: string;
                  buttonType: "AL";
                  linkAnd: string;
                  linkIos: string;
              }
              | {
                  buttonName: string;
                  buttonType: "AC"
                  | "BK"
                  | "MD"
                  | "BC"
                  | "BT"
                  | "DS";
              }
          )[];
          categoryCode: string;
          content: string;
          emphasizeSubTitle?: string;
          emphasizeTitle?: string;
          emphasizeType?: "TEXT"
          | "IMAGE"
          | "NONE"
          | "ITEM_LIST";
          extra?: string;
          header?: string;
          highlight?: {
              description?: string | null;
              imageId?: string | null;
              title?: string | null;
          };
          imageId?: string;
          item?: {
              list: readonly { description: string; title: string }[];
              summary: { description?: string | null; title?: string | null };
          };
          messageType?: "BA"
          | "EX"
          | "AD"
          | "MI";
          name: string;
          quickReplies?: readonly (
              | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
              | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
              | { linkType: "BK" | "BC" | "BT"; name: string }
          )[];
          securityFlag?: boolean;
      } & { channelId: string }
      | {
          buttons?: readonly (
              | {
                  buttonName: string;
                  buttonType: "WL";
                  linkMo: string;
                  linkPc?: string
                  | null;
              }
              | {
                  buttonName: string;
                  buttonType: "AL";
                  linkAnd: string;
                  linkIos: string;
              }
              | {
                  buttonName: string;
                  buttonType: "AC"
                  | "BK"
                  | "MD"
                  | "BC"
                  | "BT"
                  | "DS";
              }
          )[];
          categoryCode: string;
          content: string;
          emphasizeSubTitle?: string;
          emphasizeTitle?: string;
          emphasizeType?: "TEXT"
          | "IMAGE"
          | "NONE"
          | "ITEM_LIST";
          extra?: string;
          header?: string;
          highlight?: {
              description?: string | null;
              imageId?: string | null;
              title?: string | null;
          };
          imageId?: string;
          item?: {
              list: readonly { description: string; title: string }[];
              summary: { description?: string | null; title?: string | null };
          };
          messageType?: "BA"
          | "EX"
          | "AD"
          | "MI";
          name: string;
          quickReplies?: readonly (
              | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
              | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
              | { linkType: "BK" | "BC" | "BT"; name: string }
          )[];
          securityFlag?: boolean;
      } & { channelGroupId: string }
Returns Promise<KakaoAlimtalkTemplate>
Description
카카오 알림톡 템플릿 생성
- Defined in src/services/kakao/templates/kakaoTemplateService.ts:54

getKakaoAlimtalkTemplate

getKakaoAlimtalkTemplate(templateId: string): Promise<KakaoAlimtalkTemplate>
카카오 템플릿 상세 조회
Parameters
- templateId: string
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/services/kakao/templates/kakaoTemplateService.ts:122

getKakaoAlimtalkTemplateCategories

getKakaoAlimtalkTemplateCategories(): Promise<{ code: string; name: string }[]>
카카오 템플릿 카테고리 조회

Returns Promise<{ code: string; name: string }[]>
- Defined in src/services/kakao/templates/kakaoTemplateService.ts:36

getKakaoAlimtalkTemplates

getKakaoAlimtalkTemplates(
    data?: {
        channelId?: string;
        endDate?: string | Date;
        isHidden?: boolean;
        limit?: number;
        name?: string | { like: string } | { eq?: string; ne?: string };
        startDate?: string | Date;
        startKey?: string;
        status?: "PENDING" | "INSPECTING" | "APPROVED" | "REJECTED";
        templateId?: string;
    },
): Promise<GetKakaoAlimtalkTemplatesFinalizeResponse>
카카오 템플릿 목록 조회
Parameters
- Optionaldata: {
      channelId?: string;
      endDate?: string | Date;
      isHidden?: boolean;
      limit?: number;
      name?: string | { like: string } | { eq?: string; ne?: string };
      startDate?: string | Date;
      startKey?: string;
      status?: "PENDING" | "INSPECTING" | "APPROVED" | "REJECTED";
      templateId?: string;
  }
Returns Promise<GetKakaoAlimtalkTemplatesFinalizeResponse>
- Defined in src/services/kakao/templates/kakaoTemplateService.ts:75

`Protected`getWithQuery

getWithQuery<A, R, I = unknown>(
    config: {
        data?: unknown;
        finalize: (validated?: A) => object;
        responseSchema?: Schema<R, I, never>;
        schema: Schema<A>;
        url: string;
    },
): Effect<
    R,
    | InvalidDateError
    | ApiKeyError
    | DefaultError
    | BadRequestError
    | NetworkError
    | ClientError
    | ResponseSchemaMismatchError
    | ServerError,
>
Type Parameters
- A
- R
- I = unknown
Parameters
- config: {
      data?: unknown;
      finalize: (validated?: A) => object;
      responseSchema?: Schema<R, I, never>;
      schema: Schema<A>;
      url: string;
  }
Returns Effect<
    R,
    | InvalidDateError
    | ApiKeyError
    | DefaultError
    | BadRequestError
    | NetworkError
    | ClientError
    | ResponseSchemaMismatchError
    | ServerError,
>
Inherited from default.getWithQuery
- Defined in src/services/defaultService.ts:83

removeKakaoAlimtalkTemplate

removeKakaoAlimtalkTemplate(templateId: string): Promise<KakaoAlimtalkTemplate>
카카오 알림톡 템플릿 삭제(대기, 반려 상태일 때만 삭제가능)
Parameters
- templateId: string
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/services/kakao/templates/kakaoTemplateService.ts:198

`Protected`request

request<T, R, I = unknown>(
parameter: DefaultServiceParameter<T, R, I>,
): Promise<R>
Type Parameters
- T
- R
- I = unknown
Parameters
- parameter: DefaultServiceParameter<T, R, I>
Returns Promise<R>
Inherited from default.request
- Defined in src/services/defaultService.ts:77

`Protected`requestEffect

requestEffect<T, R, I = unknown>(
    parameter: DefaultServiceParameter<T, R, I>,
): Effect<
    R,
    | ApiKeyError
    | DefaultError
    | NetworkError
    | ClientError
    | ResponseSchemaMismatchError
    | ServerError,
>
Type Parameters
- T
- R
- I = unknown
Parameters
- parameter: DefaultServiceParameter<T, R, I>
Returns Effect<
    R,
    | ApiKeyError
    | DefaultError
    | NetworkError
    | ClientError
    | ResponseSchemaMismatchError
    | ServerError,
>
Inherited from default.requestEffect
- Defined in src/services/defaultService.ts:51

updateKakaoAlimtalkTemplate

updateKakaoAlimtalkTemplate(
    templateId: string,
    data: {
        buttons?: readonly (
            | {
                buttonName: string;
                buttonType: "WL";
                linkMo: string;
                linkPc?: string
                | null;
            }
            | {
                buttonName: string;
                buttonType: "AL";
                linkAnd: string;
                linkIos: string;
            }
            | {
                buttonName: string;
                buttonType: "AC"
                | "BK"
                | "MD"
                | "BC"
                | "BT"
                | "DS";
            }
        )[];
        categoryCode?: string;
        content?: string;
        emphasizeSubTitle?: string;
        emphasizeTitle?: string;
        emphasizeType?: "TEXT"
        | "IMAGE"
        | "NONE"
        | "ITEM_LIST";
        extra?: string;
        header?: string;
        highlight?: {
            description?: string | null;
            imageId?: string | null;
            title?: string | null;
        };
        imageId?: string;
        item?: {
            list: readonly { description: string; title: string }[];
            summary: { description?: string | null; title?: string | null };
        };
        messageType?: "BA"
        | "EX"
        | "AD"
        | "MI";
        name?: string;
        quickReplies?: readonly (
            | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
            | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
            | { linkType: "BK" | "BC" | "BT"; name: string }
        )[];
        securityFlag?: boolean;
    },
): Promise<KakaoAlimtalkTemplate>
카카오 알림톡 템플릿 수정(검수 X)
Parameters
- templateId: string
- data: {
      buttons?: readonly (
          | {
              buttonName: string;
              buttonType: "WL";
              linkMo: string;
              linkPc?: string
              | null;
          }
          | {
              buttonName: string;
              buttonType: "AL";
              linkAnd: string;
              linkIos: string;
          }
          | {
              buttonName: string;
              buttonType: "AC"
              | "BK"
              | "MD"
              | "BC"
              | "BT"
              | "DS";
          }
      )[];
      categoryCode?: string;
      content?: string;
      emphasizeSubTitle?: string;
      emphasizeTitle?: string;
      emphasizeType?: "TEXT"
      | "IMAGE"
      | "NONE"
      | "ITEM_LIST";
      extra?: string;
      header?: string;
      highlight?: {
          description?: string | null;
          imageId?: string | null;
          title?: string | null;
      };
      imageId?: string;
      item?: {
          list: readonly { description: string; title: string }[];
          summary: { description?: string | null; title?: string | null };
      };
      messageType?: "BA"
      | "EX"
      | "AD"
      | "MI";
      name?: string;
      quickReplies?: readonly (
          | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
          | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
          | { linkType: "BK" | "BC" | "BT"; name: string }
      )[];
      securityFlag?: boolean;
  }
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/services/kakao/templates/kakaoTemplateService.ts:157

updateKakaoAlimtalkTemplateName

updateKakaoAlimtalkTemplateName(
templateId: string,
name: string,
): Promise<KakaoAlimtalkTemplate>
카카오 알림톡 템플릿 이름 수정(검수 상태 상관없이 변경가능)
Parameters
- templateId: string
- name: string
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/services/kakao/templates/kakaoTemplateService.ts:179

Class default

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

cancelInspectionKakaoAlimtalkTemplate

Parameters

Returns Promise<KakaoAlimtalkTemplate>

createKakaoAlimtalkTemplate

Parameters

Returns Promise<KakaoAlimtalkTemplate>

Description

getKakaoAlimtalkTemplate

Parameters

Returns Promise<KakaoAlimtalkTemplate>

getKakaoAlimtalkTemplateCategories

Returns Promise<{ code: string; name: string }[]>

getKakaoAlimtalkTemplates

Parameters

Returns Promise<GetKakaoAlimtalkTemplatesFinalizeResponse>

ProtectedgetWithQuery

Type Parameters

Parameters

Returns Effect< R, | InvalidDateError | ApiKeyError | DefaultError | BadRequestError | NetworkError | ClientError | ResponseSchemaMismatchError | ServerError,>

removeKakaoAlimtalkTemplate

Parameters

Returns Promise<KakaoAlimtalkTemplate>

Protectedrequest

Type Parameters

Parameters

Returns Promise<R>

ProtectedrequestEffect

Type Parameters

Parameters

Returns Effect< R, | ApiKeyError | DefaultError | NetworkError | ClientError | ResponseSchemaMismatchError | ServerError,>

updateKakaoAlimtalkTemplate

Parameters

Returns Promise<KakaoAlimtalkTemplate>

updateKakaoAlimtalkTemplateName

Parameters

Returns Promise<KakaoAlimtalkTemplate>

Settings

On This Page

`Protected`getWithQuery

Returns Effect<
R,
| InvalidDateError
| ApiKeyError
| DefaultError
| BadRequestError
| NetworkError
| ClientError
| ResponseSchemaMismatchError
| ServerError,
>

`Protected`request

`Protected`requestEffect

Returns Effect<
R,
| ApiKeyError
| DefaultError
| NetworkError
| ClientError
| ResponseSchemaMismatchError
| ServerError,
>