@upbit-official/upbit-sdk 0.9.0 → 1.0.0

package/src/resources/travel-rule.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -12,6 +11,8 @@ export class TravelRule extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-travelrule-vasps
    * - docs(global): https://global-docs.upbit.com/reference/list-travelrule-vasps
    *
+   * Retrieves the list of exchanges supporting Travel Rule.
+   *
    * @example
    * ```ts
    * const response = await client.travelRule.listVasps();
@@ -30,6 +31,8 @@ export class TravelRule extends APIResource {
    * - docs(global):
    *   https://global-docs.upbit.com/reference/verify-travelrule-by-txid
    *
+   * Retrieves travel rule verification using the deposit TxID.
+   *
    * @example
    * ```ts
    * const verificationResult =
@@ -57,6 +60,8 @@ export class TravelRule extends APIResource {
    * - docs(global):
    *   https://global-docs.upbit.com/reference/verify-travelrule-by-uuid
    *
+   * Retrieves travel rule verification using the deposit UUID.
+   *
    * @example
    * ```ts
    * const verificationResult =

package/src/resources/wallet-status.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -11,6 +10,8 @@ export class WalletStatus extends APIResource {
    *
    * - docs(kr): https://docs.upbit.com/kr/reference/get-service-status
    * - docs(global): https://global-docs.upbit.com/reference/get-service-status
+   *
+   * Retrieves deposit and withdrawal service status for all currencies.
    */
   list(options?: RequestOptions): APIPromise<WalletStatusListResponse> {
     return this._client.get('/v1/status/wallet', options);

package/src/resources/withdraws.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { PagePromise, UuidCursorIDPage, type UuidCursorIDPageParams } from '../core/pagination';
@@ -13,6 +12,9 @@ export class Withdraws extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/get-withdrawal
    * - docs(global): https://global-docs.upbit.com/reference/get-withdrawal
    *
+   * Retrieves the latest single withdrawal information. To query a specific
+   * withdrawal, you can specify the withdrawal’s UUID or transaction ID (TXID).
+   *
    * @example
    * ```ts
    * const withdraw = await client.withdraws.retrieve();
@@ -33,6 +35,8 @@ export class Withdraws extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-withdrawals
    * - docs(global): https://global-docs.upbit.com/reference/list-withdrawals
    *
+   * Retrieves latest withdrawal list.
+   *
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
@@ -56,6 +60,9 @@ export class Withdraws extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/cancel-withdrawal
    * - docs(global): https://global-docs.upbit.com/reference/cancel-withdrawal
    *
+   * Cancel a completed digital asset withdrawal request by specifying the withdrawal
+   * UUID.
+   *
    * @example
    * ```ts
    * const withdraw = await client.withdraws.cancelWithdrawal({
@@ -74,7 +81,9 @@ export class Withdraws extends APIResource {
    * POST /v1/withdraws/krw
    *
    * - docs(kr): https://docs.upbit.com/kr/reference/withdraw-krw
-   * - docs(global): https://global-docs.upbit.com/reference/withdraw-krw
+   * - Supported only in Korea.
+   *
+   * 원화(KRW) 출금을 요청합니다.
    *
    * @example
    * ```ts
@@ -98,6 +107,8 @@ export class Withdraws extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/withdraw
    * - docs(global): https://global-docs.upbit.com/reference/withdraw
    *
+   * Requests a withdrawal of digital asset.
+   *
    * @example
    * ```ts
    * const withdraw = await client.withdraws.createWithdrawal({
@@ -121,6 +132,8 @@ export class Withdraws extends APIResource {
    * - docs(global):
    *   https://global-docs.upbit.com/reference/list-withdrawal-addresses
    *
+   * Retrieves the list of withdrawal whitelist addresses registered to the account.
+   *
    * @example
    * ```ts
    * const response = await client.withdraws.listCoinAddresses();
@@ -139,6 +152,9 @@ export class Withdraws extends APIResource {
    * - docs(global):
    *   https://global-docs.upbit.com/reference/available-withdrawal-information
    *
+   * Retrieves withdrawal availability information for the specified currency,
+   * including its withdrawal policy and user balance.
+   *
    * @example
    * ```ts
    * const response = await client.withdraws.retrieveChance({

package/src/resources/ws-private/index.ts

@@ -1,3 +1,2 @@
-
 export { WsPrivate, type ConnectPrivateClientEvent, type ConnectPrivateServerEvent } from './ws-private';
 export { type WsPrivateWSClientOptions, type WsPrivateWSReconnectOptions } from './ws';

package/src/resources/ws-private/internal-base.ts

@@ -1,4 +1,3 @@
-
 import * as WsPrivateAPI from './ws-private';
 import { Upbit } from '../../client';
 import { EventEmitter } from '../../core/EventEmitter';

package/src/resources/ws-private/ws-private.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../../core/resource';
 
 export class WsPrivate extends APIResource {}

package/src/resources/ws-private/ws.ts

@@ -1,4 +1,3 @@
-
 import * as WS from 'ws';
 import { WsPrivateEmitter, WsPrivateStreamMessage, WebSocketError, buildURL } from './internal-base';
 import { InternalEventEmitter } from '../../core/EventEmitter';

package/src/resources/ws-private.ts

@@ -1,2 +1 @@
-
 export * from './ws-private/index';

package/src/resources/ws-public/index.ts

@@ -1,3 +1,2 @@
-
 export { WsPublic, type ConnectPublicClientEvent, type ConnectPublicServerEvent } from './ws-public';
 export { type WsPublicWSClientOptions, type WsPublicWSReconnectOptions } from './ws';

package/src/resources/ws-public/internal-base.ts

@@ -1,4 +1,3 @@
-
 import * as WsPublicAPI from './ws-public';
 import { Upbit } from '../../client';
 import { EventEmitter } from '../../core/EventEmitter';

package/src/resources/ws-public/ws-public.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../../core/resource';
 
 export class WsPublic extends APIResource {}

package/src/resources/ws-public/ws.ts

@@ -1,4 +1,3 @@
-
 import * as WS from 'ws';
 import { WsPublicEmitter, WsPublicStreamMessage, WebSocketError, buildURL } from './internal-base';
 import { InternalEventEmitter } from '../../core/EventEmitter';

package/src/resources/ws-public.ts

@@ -1,2 +1 @@
-
 export * from './ws-public/index';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.9.0';
+export const VERSION = '1.0.0';

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.9.0";
+export declare const VERSION = "1.0.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.9.0";
+export declare const VERSION = "1.0.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.9.0';
+exports.VERSION = '1.0.0';
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.9.0';
+export const VERSION = '1.0.0';
 //# sourceMappingURL=version.mjs.map