kucoin-universal-sdk/dist/generate/futures/positions/model_get_positions_history_req.d.ts

Official KuCoin Universal SDK.

import { Serializable } from '../../../internal/interfaces/serializable';
export declare class GetPositionsHistoryReq implements Serializable {
    /**
     * Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220)
     */
    symbol?: string;
    /**
     * Closing start time(ms)
     */
    from?: number;
    /**
     * Closing end time(ms)
     */
    to?: number;
    /**
     * Number of requests per page, max 200, default 10
     */
    limit?: number;
    /**
     * Current page number, default 1
     */
    pageId?: number;
    /**
     * Private constructor, please use the corresponding static methods to construct the object.
     */
    private constructor();
    /**
     * Creates a new instance of the `GetPositionsHistoryReq` class.
     * The builder pattern allows step-by-step construction of a `GetPositionsHistoryReq` object.
     */
    static builder(): GetPositionsHistoryReqBuilder;
    /**
     * Creates a new instance of the `GetPositionsHistoryReq` class with the given data.
     */
    static create(data: {
        /**
         * Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220)
         */
        symbol?: string;
        /**
         * Closing start time(ms)
         */
        from?: number;
        /**
         * Closing end time(ms)
         */
        to?: number;
        /**
         * Number of requests per page, max 200, default 10
         */
        limit?: number;
        /**
         * Current page number, default 1
         */
        pageId?: number;
    }): GetPositionsHistoryReq;
    /**
     * Convert the object to a JSON string.
     */
    toJson(): string;
    /**
     * Create an object from a JSON string.
     */
    static fromJson(input: string): GetPositionsHistoryReq;
    /**
     * Create an object from Js Object.
     */
    static fromObject(jsonObject: Object): GetPositionsHistoryReq;
}
export declare class GetPositionsHistoryReqBuilder {
    readonly obj: GetPositionsHistoryReq;
    constructor(obj: GetPositionsHistoryReq);
    /**
     * Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220)
     */
    setSymbol(value: string): GetPositionsHistoryReqBuilder;
    /**
     * Closing start time(ms)
     */
    setFrom(value: number): GetPositionsHistoryReqBuilder;
    /**
     * Closing end time(ms)
     */
    setTo(value: number): GetPositionsHistoryReqBuilder;
    /**
     * Number of requests per page, max 200, default 10
     */
    setLimit(value: number): GetPositionsHistoryReqBuilder;
    /**
     * Current page number, default 1
     */
    setPageId(value: number): GetPositionsHistoryReqBuilder;
    /**
     * Get the final object.
     */
    build(): GetPositionsHistoryReq;
}