@upbit-official/upbit-sdk 0.9.0

package/resources/deposits.d.mts

@@ -0,0 +1,373 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { PagePromise, UuidCursorIDPage, type UuidCursorIDPageParams } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Deposits extends APIResource {
+    /**
+     * Get Deposit
+     *
+     * GET /v1/deposit
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/get-deposit
+     * - docs(global): https://global-docs.upbit.com/reference/get-deposit
+     *
+     * @example
+     * ```ts
+     * const deposit = await client.deposits.retrieve();
+     * ```
+     */
+    retrieve(query?: DepositRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Deposit>;
+    /**
+     * List Deposits
+     *
+     * GET /v1/deposits
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-deposits
+     * - docs(global): https://global-docs.upbit.com/reference/list-deposits
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const deposit of client.deposits.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: DepositListParams | null | undefined, options?: RequestOptions): PagePromise<DepositsUuidCursorIDPage, Deposit>;
+    /**
+     * Create Deposit Address
+     *
+     * POST /v1/deposits/generate_coin_address
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/create-deposit-address
+     * - docs(global): https://global-docs.upbit.com/reference/create-deposit-address
+     *
+     * @example
+     * ```ts
+     * const response = await client.deposits.createCoinAddress({
+     *   currency: 'BTC',
+     *   net_type: 'BTC',
+     * });
+     * ```
+     */
+    createCoinAddress(body: DepositCreateCoinAddressParams, options?: RequestOptions): APIPromise<DepositCreateCoinAddressResponse>;
+    /**
+     * Deposit KRW
+     *
+     * POST /v1/deposits/krw
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/deposit-krw
+     * - docs(global): https://global-docs.upbit.com/reference/deposit-krw
+     *
+     * @example
+     * ```ts
+     * const deposit = await client.deposits.depositKrw({
+     *   amount: '10000',
+     *   two_factor_type: 'naver',
+     * });
+     * ```
+     */
+    depositKrw(body: DepositDepositKrwParams, options?: RequestOptions): APIPromise<Deposit>;
+    /**
+     * List Deposit Addresses
+     *
+     * GET /v1/deposits/coin_addresses
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/list-deposit-addresses
+     * - docs(global): https://global-docs.upbit.com/reference/list-deposit-addresses
+     *
+     * @example
+     * ```ts
+     * const depositAddresses =
+     *   await client.deposits.listCoinAddresses();
+     * ```
+     */
+    listCoinAddresses(options?: RequestOptions): APIPromise<DepositListCoinAddressesResponse>;
+    /**
+     * Get Available Deposit Information
+     *
+     * GET /v1/deposits/chance/coin
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/available-deposit-information
+     * - docs(global):
+     *   https://global-docs.upbit.com/reference/available-deposit-information
+     *
+     * @example
+     * ```ts
+     * const response = await client.deposits.retrieveChance({
+     *   currency: 'BTC',
+     *   net_type: 'BTC',
+     * });
+     * ```
+     */
+    retrieveChance(query: DepositRetrieveChanceParams, options?: RequestOptions): APIPromise<DepositRetrieveChanceResponse>;
+    /**
+     * Get Deposit Address
+     *
+     * GET /v1/deposits/coin_address
+     *
+     * - docs(kr): https://docs.upbit.com/kr/reference/get-deposit-address
+     * - docs(global): https://global-docs.upbit.com/reference/get-deposit-address
+     *
+     * @example
+     * ```ts
+     * const depositAddress =
+     *   await client.deposits.retrieveCoinAddress({
+     *     currency: 'BTC',
+     *     net_type: 'BTC',
+     *   });
+     * ```
+     */
+    retrieveCoinAddress(query: DepositRetrieveCoinAddressParams, options?: RequestOptions): APIPromise<DepositAddress>;
+}
+export type DepositsUuidCursorIDPage = UuidCursorIDPage<Deposit>;
+export interface Deposit {
+    /**
+     * Deposit amount.
+     */
+    amount: string;
+    /**
+     * Timestamp when the deposit was requested.
+     *
+     * [Format] yyyy-MM-ddTHH:mm:ss+00:00
+     */
+    created_at: string;
+    /**
+     * Currency code of the deposit.
+     */
+    currency: string;
+    /**
+     * Timestamp when the deposit was completed.
+     *
+     * [Format] yyyy-MM-ddTHH:mm:ss+00:00
+     */
+    done_at: string | null;
+    /**
+     * Deposit fee.
+     */
+    fee: string;
+    /**
+     * Deposit status.
+     *
+     * - `PROCESSING`: Deposit in progress (digital asset only)
+     * - `ACCEPTED`: Completed
+     * - `CANCELLED`: Cancelled
+     * - `REJECTED`: Rejected
+     * - `TRAVEL_RULE_SUSPECTED`: Awaiting additional Travel Rule verification (digital
+     *   assets only)
+     * - `REFUNDING`: Refund in progress
+     * - `REFUNDED`: Refunded (digital asset only)
+     */
+    state: 'PROCESSING' | 'ACCEPTED' | 'CANCELLED' | 'REJECTED' | 'TRAVEL_RULE_SUSPECTED' | 'REFUNDING' | 'REFUNDED';
+    /**
+     * Deposit transaction type.
+     *
+     * - `default`: Standard deposit
+     * - `internal`: Internal deposit (between Upbit accounts)
+     */
+    transaction_type: 'default' | 'internal';
+    /**
+     * Deposit transaction ID.
+     */
+    txid: string;
+    /**
+     * Transaction type.
+     */
+    type: string;
+    /**
+     * Unique identifier (UUID) of the deposit.
+     */
+    uuid: string;
+    /**
+     * Deposit network type. Returns null for fiat (KRW) deposits.
+     *
+     * [Example] ETH, TRX, SOL
+     */
+    net_type?: string | null;
+}
+export interface DepositAddress {
+    /**
+     * Currency code for which the deposit address was created.
+     */
+    currency: string;
+    /**
+     * Deposit address.
+     */
+    deposit_address: string;
+    /**
+     * Deposit network type.
+     *
+     * Blockchain network identifier used by Upbit.
+     *
+     * [Example] ETH, TRX, SOL
+     */
+    net_type: string | null;
+    /**
+     * Secondary deposit address (Destination Tag, Memo, or Message).
+     */
+    secondary_address?: string | null;
+}
+export type DepositCreateCoinAddressResponse = DepositAddress | DepositCreateCoinAddressResponse.GenerateCoinAddressResponse;
+export declare namespace DepositCreateCoinAddressResponse {
+    interface GenerateCoinAddressResponse {
+        /**
+         * Message about the deposit address creation request.
+         */
+        message: string;
+        /**
+         * Whether the deposit address creation request was accepted.
+         */
+        success: boolean;
+    }
+}
+export type DepositListCoinAddressesResponse = Array<DepositAddress>;
+export interface DepositRetrieveChanceResponse {
+    /**
+     * Currency code to be queried.
+     */
+    currency: string;
+    /**
+     * Decimal precision applied to deposits.
+     */
+    decimal_precision: number;
+    /**
+     * Reason why deposits are not possible.
+     *
+     * ※ Provided when "is_deposit_possible" is "false".
+     */
+    deposit_impossible_reason: string;
+    /**
+     * Whether deposits are currently possible.
+     */
+    is_deposit_possible: boolean;
+    /**
+     * Minimum deposit amount.
+     */
+    minimum_deposit_amount: string;
+    /**
+     * Minimum number of blockchain confirmations required for the deposit to be
+     * credited.
+     */
+    minimum_deposit_confirmations: number;
+    /**
+     * Deposit network type.
+     *
+     * Blockchain network identifier used by Upbit.
+     *
+     * [Example] ETH, TRX, SOL
+     */
+    net_type: string | null;
+}
+export interface DepositRetrieveParams {
+    /**
+     * Currency code filter.
+     */
+    currency?: string;
+    /**
+     * Transaction ID of the deposit to query.
+     *
+     * If neither uuid nor txid is provided, the latest deposit is returned.
+     */
+    txid?: string;
+    /**
+     * UUID of the deposit to query.
+     *
+     * If neither uuid nor txid is provided, the latest deposit is returned.
+     */
+    uuid?: string;
+}
+export interface DepositListParams extends UuidCursorIDPageParams {
+    /**
+     * Currency code filter. If not specified, the latest deposits are returned.
+     */
+    currency?: string;
+    /**
+     * Cursor for pagination. Enter a "uuid" from the response to retrieve "limit"
+     * deposits after that timestamp.
+     */
+    from?: string;
+    /**
+     * Sort order. "desc" (newest first) or "asc" (oldest first). Default is "desc".
+     */
+    order_by?: 'asc' | 'desc';
+    /**
+     * Page number for pagination. Default is 1.
+     */
+    page?: number;
+    /**
+     * Deposit state filter.
+     *
+     * - `PROCESSING`: Processing
+     * - `ACCEPTED`: Completed
+     * - `CANCELLED`: Cancelled
+     * - `REJECTED`: Rejected
+     * - `TRAVEL_RULE_SUSPECTED`: Pending Travel Rule verification
+     * - `REFUNDING`: Refund in progress
+     * - `REFUNDED`: Refunded
+     */
+    state?: 'PROCESSING' | 'ACCEPTED' | 'CANCELLED' | 'REJECTED' | 'TRAVEL_RULE_SUSPECTED' | 'REFUNDING' | 'REFUNDED';
+    /**
+     * List of transaction IDs to query.
+     *
+     * [Example] txids[]=txid1&txids[]=txid2
+     */
+    txids?: Array<string>;
+    /**
+     * List of UUIDs to query.
+     *
+     * [Example] uuids[]=uuid1&uuids[]=uuid2
+     */
+    uuids?: Array<string>;
+}
+export interface DepositCreateCoinAddressParams {
+    /**
+     * Currency code for which to create a deposit address.
+     */
+    currency: string;
+    /**
+     * Network type.
+     */
+    net_type: string;
+}
+export interface DepositDepositKrwParams {
+    /**
+     * KRW amount to deposit.
+     */
+    amount: string;
+    /**
+     * Two-factor authentication method for KRW transactions.
+     *
+     * - `kakao`: Kakao authentication
+     * - `naver`: Naver authentication
+     * - `hana`: Hana certificate authentication
+     */
+    two_factor_type: 'kakao' | 'naver' | 'hana';
+}
+export interface DepositRetrieveChanceParams {
+    /**
+     * Currency code to query deposit availability for.
+     */
+    currency: string;
+    /**
+     * Blockchain network identifier for digital asset deposit.
+     *
+     * Used to filter by network.
+     */
+    net_type: string;
+}
+export interface DepositRetrieveCoinAddressParams {
+    /**
+     * Currency code to query.
+     */
+    currency: string;
+    /**
+     * Blockchain network identifier.
+     *
+     * Used to filter by network.
+     */
+    net_type: string;
+}
+export declare namespace Deposits {
+    export { type Deposit as Deposit, type DepositAddress as DepositAddress, type DepositCreateCoinAddressResponse as DepositCreateCoinAddressResponse, type DepositListCoinAddressesResponse as DepositListCoinAddressesResponse, type DepositRetrieveChanceResponse as DepositRetrieveChanceResponse, type DepositsUuidCursorIDPage as DepositsUuidCursorIDPage, type DepositRetrieveParams as DepositRetrieveParams, type DepositListParams as DepositListParams, type DepositCreateCoinAddressParams as DepositCreateCoinAddressParams, type DepositDepositKrwParams as DepositDepositKrwParams, type DepositRetrieveChanceParams as DepositRetrieveChanceParams, type DepositRetrieveCoinAddressParams as DepositRetrieveCoinAddressParams, };
+}
+//# sourceMappingURL=deposits.d.mts.map

package/resources/deposits.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deposits.d.mts","sourceRoot":"","sources":["../src/resources/deposits.ts"],"names":[],"mappings":"OACO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE;OAC9D,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,wBAAwB,EAAE,OAAO,CAAC;IAIjD;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIxF;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gCAAgC,CAAC;IAIzF;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CACZ,KAAK,EAAE,2BAA2B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;;;;;;;OAgBG;IACH,mBAAmB,CACjB,KAAK,EAAE,gCAAgC,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;CAG9B;AAED,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;AAEjE,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;;OAWG;IACH,KAAK,EACD,YAAY,GACZ,UAAU,GACV,WAAW,GACX,UAAU,GACV,uBAAuB,GACvB,WAAW,GACX,UAAU,CAAC;IAEf;;;;;OAKG;IACH,gBAAgB,EAAE,SAAS,GAAG,UAAU,CAAC;IAEzC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,MAAM,gCAAgC,GACxC,cAAc,GACd,gCAAgC,CAAC,2BAA2B,CAAC;AAEjE,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,MAAM,gCAAgC,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAErE,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAkB,SAAQ,sBAAsB;IAC/D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EACF,YAAY,GACZ,UAAU,GACV,WAAW,GACX,UAAU,GACV,uBAAuB,GACvB,WAAW,GACX,UAAU,CAAC;IAEf;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,eAAe,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;CAC7C;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}