/** * Using these objects we can construct appropriate enum with auto completion and information * on each available option, if that makes sense. * * @packageDocumentation */ /** * @category Enums - Response Properties * @enum * * @see related {@link _types.KumaPosition KumaPosition Interface} */ export declare const PositionSide: Readonly<{ readonly long: "long"; readonly short: "short"; readonly none: "none"; }>; export type PositionSide = (typeof PositionSide)[keyof typeof PositionSide]; /** * Specialized fill types which do not include orders and may produce different * messaging / types in various places within the code. */ export declare const FillTypeSystem: Readonly<{ /** * Position closures resulting from forced liquidation or ADL. */ readonly liquidation: "liquidation"; /** * Position closure as the counterparty to an ADL action. */ readonly deleverage: "deleverage"; /** * Position closures resulting from forced dust liquidation. */ readonly closure: "closure"; }>; export type FillTypeSystem = (typeof FillTypeSystem)[keyof typeof FillTypeSystem]; /** * Fill types associated with an order. */ export declare const FillTypeOrder: Readonly<{ /** * Fills resulting from any type of market order. */ readonly market: "market"; /** * Fills resulting from any type of limit order. */ readonly limit: "limit"; }>; export type FillTypeOrder = (typeof FillTypeOrder)[keyof typeof FillTypeOrder]; /** * Whether the fill increases or decreases the notional value of the position. * * - Includes {@link FillTypeSysem} properties which may produce different * message types in places like the WebSocket API. * * @category Enums - Response Properties * @enum */ export declare const FillType: Readonly<{ liquidation: "liquidation"; deleverage: "deleverage"; closure: "closure"; market: "market"; limit: "limit"; }>; export type FillType = (typeof FillType)[keyof typeof FillType]; /** * @category Enums - Response Properties * @enum */ export declare const FillAction: Readonly<{ readonly open: "open"; readonly close: "close"; readonly closeAndOpen: "closeAndOpen"; }>; export type FillAction = (typeof FillAction)[keyof typeof FillAction]; /** * Order state is included in all order endpoint responses. Orders are not guaranteed to enter the open state before * reporting as another state. For example, a limit order that is completely filled on execution first reports in the * filled state in endpoint responses. * * @category Enums - Response Properties * @enum * * @see related {@link _types.KumaOrder KumaOrder Interface} * @see docs [API Documentation - Order States & Lifecycle](https://api-docs-v1.kuma.bid/#order-states-amp-lifecycle) */ export declare const OrderStatus: Readonly<{ /** * Stop order exists on the order book */ readonly active: "active"; /** * Limit order was canceled prior to execution completion but may be partially filled */ readonly canceled: "canceled"; /** * Limit order is completely filled and is no longer on the book; market order was filled */ readonly filled: "filled"; /** * Conditional and trailing stop orders that have not yet entered the active state */ readonly inactive: "inactive"; /** * Order ID to cancel was not found */ readonly notFound: "notFound"; /** * Limit order exists on the order book */ readonly open: "open"; /** * Limit order has completed fills but has remaining open quantity */ readonly partiallyFilled: "partiallyFilled"; }>; export type OrderStatus = (typeof OrderStatus)[keyof typeof OrderStatus]; /** * @category Enums - Response Properties * @enum */ export declare const OrderStateChange: Readonly<{ /** * An order without a stop has been accepted into the trading engine. * Will not be sent as a discrete change event if the order matches on execution. */ readonly new: "new"; /** * A stop order has been accepted into the trading engine. Once triggered, it * will go through other normal events starting with "new". */ readonly activated: "activated"; /** * A conditional or trailing stop order has been accepted into the trading * engine, but has not yet entered the active state. Once activated, it * will go through other stop order events starting with "activated". * * @internal */ readonly accepted: "accepted"; /** * An order has generated a fill, both on maker and taker sides. * Will be the first change event sent if an order matches on execution. */ readonly fill: "fill"; /** * An order is canceled by the user. */ readonly canceled: "canceled"; /** * LIMIT FOK orders with no fill, LIMIT IOC or MARKET orders that partially fill, GTT orders past time. */ readonly expired: "expired"; }>; export type OrderStateChange = (typeof OrderStateChange)[keyof typeof OrderStateChange]; /** * @category Enums - Response Properties * @enum */ export declare const MarketStatus: Readonly<{ /** * No orders or cancels accepted */ readonly inactive: "inactive"; /** * Cancels accepted but not trades */ readonly cancelsOnly: "cancelsOnly"; /** * Cancels and gtx orders only */ readonly limitMakerOnly: "limitMakerOnly"; /** * Trades and cancels accepted */ readonly active: "active"; /** * Hybrid trades and cancels accepted */ readonly activeHybrid: "activeHybrid"; }>; export type MarketStatus = (typeof MarketStatus)[keyof typeof MarketStatus]; /** * @category Enums - Response Properties * @enum * * @see related {@link _types.KumaOrder KumaOrder} */ export declare const TriggerType: Readonly<{ readonly last: "last"; readonly index: "index"; /** * @internal */ readonly none: "none"; }>; export type TriggerType = (typeof TriggerType)[keyof typeof TriggerType]; /** * @category Enums - Response Properties * @enum */ export declare const ChainTransactionStatus: Readonly<{ /** Either not yet submitted or not yet mined */ readonly pending: "pending"; /** Mined, no need for any block confirmation delay */ readonly mined: "mined"; /** Transaction reverted */ readonly failed: "failed"; }>; export type ChainTransactionStatus = (typeof ChainTransactionStatus)[keyof typeof ChainTransactionStatus]; /** * @category Enums - Response Properties * @enum */ export declare const LiquidityProvider: Readonly<{ /** * Maker provides liquidity */ readonly maker: "maker"; /** * Taker removes liquidity */ readonly taker: "taker"; }>; export type LiquidityProvider = (typeof LiquidityProvider)[keyof typeof LiquidityProvider]; /** * @category Enums - Response Properties * @enum */ export declare const OrderBookLevelType: Readonly<{ readonly limit: "limit"; }>; export type OrderBookLevelType = (typeof OrderBookLevelType)[keyof typeof OrderBookLevelType]; /** * Can be used as a convenience when specifying your orders for WebSocket * to benefit from inline documentation and auto-complete. * * @category Enums - Response Properties * @enum */ export declare const PositionEventStatus: Readonly<{ /** * - Default when position is open. */ open: "open"; /** * - Only {@link closed} on last update. */ closed: "closed"; }>; export type PositionEventStatus = (typeof PositionEventStatus)[keyof typeof PositionEventStatus]; /** * @category Enums - Response Properties * @enum */ export declare const MessageEventType: Readonly<{ readonly tickers: "tickers"; readonly trades: "trades"; readonly liquidations: "liquidations"; readonly candles: "candles"; readonly l1orderbook: "l1orderbook"; readonly l2orderbook: "l2orderbook"; readonly webclient: "webclient"; readonly deposits: "deposits"; readonly fundingPayments: "fundingPayments"; readonly orders: "orders"; readonly positions: "positions"; readonly withdrawals: "withdrawals"; /** * **Subscription Update Events:** * * - Receives a {@link _types.KumaErrorEvent KumaErrorEvent} WebSocket response via * the {@link _types.WebSocketClient.onMessage WebSocketClient.onMessage} handler * detailing an error that occured while processing your request on the server. */ readonly error: "error"; /** * Recieving a list of all active subscriptions. * * **Subscription Update Events:** * * - Receives a {@link _types.KumaSubscriptionsListEvent KumaSubscriptionsListEvent} WebSocket response via * the {@link _types.WebSocketClient.onMessage WebSocketClient.onMessage} handler listing all active * subscriptions as an array on the {@link _types.KumaSubscriptionsListEvent.subscriptions subscriptions} property */ readonly subscriptions: "subscriptions"; }>; export type MessageEventType = (typeof MessageEventType)[keyof typeof MessageEventType]; /** * @internal */ export declare const WebClientEvent: { readonly reload_banners: "reload_banners"; readonly exchange_status_updated: "exchange_status_updated"; readonly transaction_settled: "transaction_settled"; /** * At this time this event is not active. */ readonly buy_crypto_completed: "buy_crypto_completed"; }; /** * @internal */ export type WebClientEvent = (typeof WebClientEvent)[keyof typeof WebClientEvent]; /** * @internal */ export declare const WebClientEventExchangeStatusAction: { readonly controls_wallet: "controls_wallet"; readonly controls_exchange: "controls_exchange"; readonly controls_market: "controls_market"; }; /** * @internal */ export type WebClientEventExchangeStatusAction = (typeof WebClientEventExchangeStatusAction)[keyof typeof WebClientEventExchangeStatusAction]; /** * @internal */ export declare const WebClientEventTxSettledAction: { readonly payout: "payout"; readonly withdraw: "withdraw"; readonly executeTrade: "executeTrade"; }; export type WebClientEventTxSettledAction = (typeof WebClientEventTxSettledAction)[keyof typeof WebClientEventTxSettledAction]; //# sourceMappingURL=response.d.ts.map