@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/types/enums/response.d.ts

@@ -0,0 +1,329 @@
+/**
+ *  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.KatanaPerpsPosition KatanaPerpsPosition 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.KatanaPerpsOrder KatanaPerpsOrder Interface}
+ * @see docs    [API Documentation - Order States & Lifecycle](https://api-docs-v1-perps.katana.network/#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.KatanaPerpsOrder KatanaPerpsOrder}
+ */
+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.KatanaPerpsErrorEvent KatanaPerpsErrorEvent} 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.KatanaPerpsSubscriptionsListEvent KatanaPerpsSubscriptionsListEvent} WebSocket response via
+     *   the {@link _types.WebSocketClient.onMessage WebSocketClient.onMessage} handler listing all active
+     *   subscriptions as an array on the {@link _types.KatanaPerpsSubscriptionsListEvent.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

package/dist/types/enums/response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../src/types/enums/response.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AAEH;;;;;GAKG;AACH,eAAO,MAAM,YAAY;;;;EAId,CAAC;AAEZ,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E;;;GAGG;AACH,eAAO,MAAM,cAAc;IACzB;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;EAEM,CAAC;AAEZ,MAAM,MAAM,cAAc,GACxB,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,aAAa;IACxB;;OAEG;;IAEH;;OAEG;;EAEM,CAAC;AAEZ,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE/E;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ;;;;;;EAGnB,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,OAAO,QAAQ,CAAC,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,UAAU;;;;EAIZ,CAAC;AAEZ,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAEtE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW;IACtB;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;EAEM,CAAC;AAEZ,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;;;OAMG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAEH;;OAEG;;EAEM,CAAC;AAEZ,MAAM,MAAM,gBAAgB,GAC1B,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,YAAY;IACvB;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;EAEM,CAAC;AAEZ,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E;;;;;GAKG;AACH,eAAO,MAAM,WAAW;;;IAGtB;;OAEG;;EAEM,CAAC;AAEZ,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACH,eAAO,MAAM,sBAAsB;IACjC,gDAAgD;;IAEhD,sDAAsD;;IAEtD,2BAA2B;;EAElB,CAAC;AAEZ,MAAM,MAAM,sBAAsB,GAChC,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,OAAO,sBAAsB,CAAC,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,iBAAiB;IAC5B;;OAEG;;IAEH;;OAEG;;EAEM,CAAC;AAEZ,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAE7D;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;EAEpB,CAAC;AAEZ,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;IAC9B;;OAEG;;IAEH;;OAEG;;EAEH,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAC7B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;IAC3B;;;;;;OAMG;;IAEH;;;;;;;;OAQG;;EAIM,CAAC;AAEZ,MAAM,MAAM,gBAAgB,GAC1B,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,cAAc;;;;IAIzB;;OAEG;;CAEK,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,cAAc,GACxB,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;CAIrC,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAC5C,CAAC,OAAO,kCAAkC,CAAC,CAAC,MAAM,OAAO,kCAAkC,CAAC,CAAC;AAE/F;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;CAIhC,CAAC;AAEX,MAAM,MAAM,6BAA6B,GACvC,CAAC,OAAO,6BAA6B,CAAC,CAAC,MAAM,OAAO,6BAA6B,CAAC,CAAC"}

package/dist/types/enums/response.js

@@ -0,0 +1,296 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebClientEventTxSettledAction = exports.WebClientEventExchangeStatusAction = exports.WebClientEvent = exports.MessageEventType = exports.PositionEventStatus = exports.OrderBookLevelType = exports.LiquidityProvider = exports.ChainTransactionStatus = exports.TriggerType = exports.MarketStatus = exports.OrderStateChange = exports.OrderStatus = exports.FillAction = exports.FillType = exports.FillTypeOrder = exports.FillTypeSystem = exports.PositionSide = void 0;
+const request_1 = require("#types/enums/request");
+/**
+ *  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.KatanaPerpsPosition KatanaPerpsPosition Interface}
+ */
+exports.PositionSide = Object.freeze({
+    long: 'long',
+    short: 'short',
+    none: 'none',
+});
+/**
+ * Specialized fill types which do not include orders and may produce different
+ * messaging / types in various places within the code.
+ */
+exports.FillTypeSystem = Object.freeze({
+    /**
+     * Position closures resulting from forced liquidation or ADL.
+     */
+    liquidation: 'liquidation',
+    /**
+     * Position closure as the counterparty to an ADL action.
+     */
+    deleverage: 'deleverage',
+    /**
+     * Position closures resulting from forced dust liquidation.
+     */
+    closure: 'closure',
+});
+/**
+ * Fill types associated with an order.
+ */
+exports.FillTypeOrder = Object.freeze({
+    /**
+     * Fills resulting from any type of market order.
+     */
+    market: 'market',
+    /**
+     * Fills resulting from any type of limit order.
+     */
+    limit: 'limit',
+});
+/**
+ * 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
+ */
+exports.FillType = Object.freeze({
+    ...exports.FillTypeOrder,
+    ...exports.FillTypeSystem,
+});
+/**
+ * @category Enums - Response Properties
+ * @enum
+ */
+exports.FillAction = Object.freeze({
+    open: 'open',
+    close: 'close',
+    closeAndOpen: 'closeAndOpen',
+});
+/**
+ * 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.KatanaPerpsOrder KatanaPerpsOrder Interface}
+ * @see docs    [API Documentation - Order States & Lifecycle](https://api-docs-v1-perps.katana.network/#order-states-amp-lifecycle)
+ */
+exports.OrderStatus = Object.freeze({
+    /**
+     * Stop order exists on the order book
+     */
+    active: 'active',
+    /**
+     * Limit order was canceled prior to execution completion but may be partially filled
+     */
+    canceled: 'canceled',
+    /**
+     * Limit order is completely filled and is no longer on the book; market order was filled
+     */
+    filled: 'filled',
+    /**
+     * Conditional and trailing stop orders that have not yet entered the active state
+     */
+    inactive: 'inactive',
+    /**
+     * Order ID to cancel was not found
+     */
+    notFound: 'notFound',
+    /**
+     * Limit order exists on the order book
+     */
+    open: 'open',
+    /**
+     * Limit order has completed fills but has remaining open quantity
+     */
+    partiallyFilled: 'partiallyFilled',
+});
+/**
+ * @category Enums - Response Properties
+ * @enum
+ */
+exports.OrderStateChange = Object.freeze({
+    /**
+     * 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.
+     */
+    new: 'new',
+    /**
+     * A stop order has been accepted into the trading engine. Once triggered, it
+     * will go through other normal events starting with "new".
+     */
+    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
+     */
+    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.
+     */
+    fill: 'fill',
+    /**
+     * An order is canceled by the user.
+     */
+    canceled: 'canceled',
+    /**
+     * LIMIT FOK orders with no fill, LIMIT IOC or MARKET orders that partially fill, GTT orders past time.
+     */
+    expired: 'expired',
+});
+/**
+ * @category Enums - Response Properties
+ * @enum
+ */
+exports.MarketStatus = Object.freeze({
+    /**
+     * No orders or cancels accepted
+     */
+    inactive: 'inactive',
+    /**
+     * Cancels accepted but not trades
+     */
+    cancelsOnly: 'cancelsOnly',
+    /**
+     * Cancels and gtx orders only
+     */
+    limitMakerOnly: 'limitMakerOnly',
+    /**
+     * Trades and cancels accepted
+     */
+    active: 'active',
+    /**
+     * Hybrid trades and cancels accepted
+     */
+    activeHybrid: 'activeHybrid',
+});
+/**
+ * @category Enums - Response Properties
+ * @enum
+ *
+ * @see related {@link _types.KatanaPerpsOrder KatanaPerpsOrder}
+ */
+exports.TriggerType = Object.freeze({
+    last: 'last',
+    index: 'index',
+    /**
+     * @internal
+     */
+    none: 'none',
+});
+/**
+ * @category Enums - Response Properties
+ * @enum
+ */
+exports.ChainTransactionStatus = Object.freeze({
+    /** Either not yet submitted or not yet mined */
+    pending: 'pending',
+    /** Mined, no need for any block confirmation delay */
+    mined: 'mined',
+    /** Transaction reverted */
+    failed: 'failed',
+});
+/**
+ * @category Enums - Response Properties
+ * @enum
+ */
+exports.LiquidityProvider = Object.freeze({
+    /**
+     * Maker provides liquidity
+     */
+    maker: 'maker',
+    /**
+     * Taker removes liquidity
+     */
+    taker: 'taker',
+});
+/**
+ * @category Enums - Response Properties
+ * @enum
+ */
+exports.OrderBookLevelType = Object.freeze({
+    limit: 'limit',
+});
+/**
+ * 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
+ */
+exports.PositionEventStatus = Object.freeze({
+    /**
+     * - Default when position is open.
+     */
+    open: 'open',
+    /**
+     * - Only {@link closed} on last update.
+     */
+    closed: 'closed',
+});
+/**
+ * @category Enums - Response Properties
+ * @enum
+ */
+exports.MessageEventType = Object.freeze({
+    /**
+     * **Subscription Update Events:**
+     *
+     * - Receives a {@link _types.KatanaPerpsErrorEvent KatanaPerpsErrorEvent} WebSocket response via
+     *   the {@link _types.WebSocketClient.onMessage WebSocketClient.onMessage} handler
+     *   detailing an error that occured while processing your request on the server.
+     */
+    error: 'error',
+    /**
+     * Recieving a list of all active subscriptions.
+     *
+     * **Subscription Update Events:**
+     *
+     * - Receives a {@link _types.KatanaPerpsSubscriptionsListEvent KatanaPerpsSubscriptionsListEvent} WebSocket response via
+     *   the {@link _types.WebSocketClient.onMessage WebSocketClient.onMessage} handler listing all active
+     *   subscriptions as an array on the {@link _types.KatanaPerpsSubscriptionsListEvent.subscriptions subscriptions} property
+     */
+    subscriptions: 'subscriptions',
+    ...request_1.SubscriptionNameAuthenticated,
+    ...request_1.SubscriptionNamePublic,
+});
+/**
+ * @internal
+ */
+exports.WebClientEvent = {
+    reload_banners: 'reload_banners',
+    exchange_status_updated: 'exchange_status_updated',
+    transaction_settled: 'transaction_settled',
+    /**
+     * At this time this event is not active.
+     */
+    buy_crypto_completed: 'buy_crypto_completed',
+};
+/**
+ * @internal
+ */
+exports.WebClientEventExchangeStatusAction = {
+    controls_wallet: 'controls_wallet',
+    controls_exchange: 'controls_exchange',
+    controls_market: 'controls_market',
+};
+/**
+ * @internal
+ */
+exports.WebClientEventTxSettledAction = {
+    payout: 'payout',
+    withdraw: 'withdraw',
+    executeTrade: 'executeTrade',
+};