Class default

Hierarchy (View Summary)

default
- default

Index

Constructors

constructor

Methods

getBalance getWithQuery request requestEffect

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

getBalance

getBalance(): Promise<
    {
        accountId?: string;
        autoRecharge?: number;
        balance: number;
        balanceOnly?: number;
        deposit?: number;
        lowBalanceAlert?: {
            balances: readonly number[];
            channels: readonly string[];
            currentBalance: string;
            enabled: boolean;
            notificationBalance: string;
        };
        minimumCash?: number;
        point: number;
        rechargeTo?: number;
        rechargeTryCount?: number;
    },
>
잔액조회

Returns Promise<
    {
        accountId?: string;
        autoRecharge?: number;
        balance: number;
        balanceOnly?: number;
        deposit?: number;
        lowBalanceAlert?: {
            balances: readonly number[];
            channels: readonly string[];
            currentBalance: string;
            enabled: boolean;
            notificationBalance: string;
        };
        minimumCash?: number;
        point: number;
        rechargeTo?: number;
        rechargeTryCount?: number;
    },
>
GetBalanceResponse
- Defined in src/services/cash/cashService.ts:13

`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

Class default

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

getBalance

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

Settings

On This Page

Class default

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

getBalance

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

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