Class default

Hierarchy (View Summary)

default
- default

Index

Constructors

constructor

Methods

getWithQuery request requestEffect uploadFile

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

`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

`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

uploadFile

uploadFile(
    filePath: string,
    fileType:
        | "MMS"
        | "FAX"
        | "BMS_WIDE"
        | "KAKAO"
        | "DOCUMENT"
        | "RCS"
        | "BMS"
        | "BMS_WIDE_MAIN_ITEM_LIST"
        | "BMS_WIDE_SUB_ITEM_LIST"
        | "BMS_CAROUSEL_FEED_LIST"
        | "BMS_CAROUSEL_COMMERCE_LIST",
    name?: string,
    link?: string,
): Promise<
    { fileId: string; link: string
    | null
    | undefined; type: string },
>
파일(이미지) 업로드 카카오 친구톡 이미지는 500kb, MMS는 200kb, 발신번호 서류 인증용 파일은 2mb의 제한이 있음
Parameters
- filePath: string
  해당 파일의 경로 또는 접근 가능한 이미지 URL
- fileType:
      | "MMS"
      | "FAX"
      | "BMS_WIDE"
      | "KAKAO"
      | "DOCUMENT"
      | "RCS"
      | "BMS"
      | "BMS_WIDE_MAIN_ITEM_LIST"
      | "BMS_WIDE_SUB_ITEM_LIST"
      | "BMS_CAROUSEL_FEED_LIST"
      | "BMS_CAROUSEL_COMMERCE_LIST"
  저장할 파일의 유형, 예) 카카오 친구톡 용 이미지 -> KAKAO, MMS용 사진 -> MMS, 발신번호 서류 인증에 쓰이는 문서 등 -> DOCUMENT, RCS 이미지 -> RCS
- Optionalname: string
  파일 이름
- Optionallink: string
  파일 링크, 친구톡의 경우 필수 값
Returns Promise<{ fileId: string; link: string | null | undefined; type: string }>
- Defined in src/services/storage/storageService.ts:20

Class default

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

`Protected`getWithQuery

Type Parameters

Parameters

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

`Protected`request

Type Parameters

Parameters

Returns Promise<R>

`Protected`requestEffect

Type Parameters

Parameters

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

uploadFile

Parameters

Returns Promise<{ fileId: string; link: string | null | undefined; type: string }>

Settings

On This Page

Class default

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

ProtectedgetWithQuery

Type Parameters

Parameters

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

Protectedrequest

Type Parameters

Parameters

Returns Promise<R>

ProtectedrequestEffect

Type Parameters

Parameters

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

uploadFile

Parameters

Returns Promise<{ fileId: string; link: string | null | undefined; type: string }>

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,
>