kucoin-universal-sdk/dist/generate/account/deposit/model_add_deposit_address_v3_req.d.ts

Official KuCoin Universal SDK.

import { Serializable } from '../../../internal/interfaces/serializable';
export declare class AddDepositAddressV3Req implements Serializable {
    /**
     * currency
     */
    currency: string;
    /**
     * The currency chainId, e.g. the available values for USDT are OMNI, ERC20, and TRC20; default is ERC20. The available values for BTC are Native, Segwit, TRC20; the parameters are bech32, btc, trx; default is Native.
     */
    chain: string;
    /**
     * Deposit account type: MAIN (funding account), TRADE (spot trading account); the default is MAIN
     */
    to?: AddDepositAddressV3Req.ToEnum;
    /**
     * Deposit amount. This parameter is only used when applying for invoices on the Lightning Network. This parameter is invalid if it is not passed through the Lightning Network.
     */
    amount?: string;
    /**
     * Private constructor, please use the corresponding static methods to construct the object.
     */
    private constructor();
    /**
     * Creates a new instance of the `AddDepositAddressV3Req` class.
     * The builder pattern allows step-by-step construction of a `AddDepositAddressV3Req` object.
     */
    static builder(): AddDepositAddressV3ReqBuilder;
    /**
     * Creates a new instance of the `AddDepositAddressV3Req` class with the given data.
     */
    static create(data: {
        /**
         * currency
         */
        currency: string;
        /**
         * The currency chainId, e.g. the available values for USDT are OMNI, ERC20, and TRC20; default is ERC20. The available values for BTC are Native, Segwit, TRC20; the parameters are bech32, btc, trx; default is Native.
         */
        chain: string;
        /**
         * Deposit account type: MAIN (funding account), TRADE (spot trading account); the default is MAIN
         */
        to?: AddDepositAddressV3Req.ToEnum;
        /**
         * Deposit amount. This parameter is only used when applying for invoices on the Lightning Network. This parameter is invalid if it is not passed through the Lightning Network.
         */
        amount?: string;
    }): AddDepositAddressV3Req;
    /**
     * Convert the object to a JSON string.
     */
    toJson(): string;
    /**
     * Create an object from a JSON string.
     */
    static fromJson(input: string): AddDepositAddressV3Req;
    /**
     * Create an object from Js Object.
     */
    static fromObject(jsonObject: Object): AddDepositAddressV3Req;
}
export declare namespace AddDepositAddressV3Req {
    enum ToEnum {
        /**
         * Funding account
         */
        MAIN,
        /**
         * Spot account
         */
        TRADE
    }
}
export declare class AddDepositAddressV3ReqBuilder {
    readonly obj: AddDepositAddressV3Req;
    constructor(obj: AddDepositAddressV3Req);
    /**
     * currency
     */
    setCurrency(value: string): AddDepositAddressV3ReqBuilder;
    /**
     * The currency chainId, e.g. the available values for USDT are OMNI, ERC20, and TRC20; default is ERC20. The available values for BTC are Native, Segwit, TRC20; the parameters are bech32, btc, trx; default is Native.
     */
    setChain(value: string): AddDepositAddressV3ReqBuilder;
    /**
     * Deposit account type: MAIN (funding account), TRADE (spot trading account); the default is MAIN
     */
    setTo(value: AddDepositAddressV3Req.ToEnum): AddDepositAddressV3ReqBuilder;
    /**
     * Deposit amount. This parameter is only used when applying for invoices on the Lightning Network. This parameter is invalid if it is not passed through the Lightning Network.
     */
    setAmount(value: string): AddDepositAddressV3ReqBuilder;
    /**
     * Get the final object.
     */
    build(): AddDepositAddressV3Req;
}