pmxtjs 2.27.4 → 2.27.6

package/dist/esm/generated/src/models/Balance.d.ts

@@ -22,13 +22,13 @@ export interface Balance {
      */
     currency: string;
     /**
-     *
+     * Total balance including funds locked in open orders.
      * @type {number}
      * @memberof Balance
      */
     total: number;
     /**
-     *
+     * Balance available to trade (excludes locked funds).
      * @type {number}
      * @memberof Balance
      */

package/dist/esm/generated/src/models/CreateOrderParams.d.ts

@@ -16,31 +16,31 @@
  */
 export interface CreateOrderParams {
     /**
-     *
+     * The market to trade on.
      * @type {string}
      * @memberof CreateOrderParams
      */
     marketId: string;
     /**
-     *
+     * The outcome to trade.
      * @type {string}
      * @memberof CreateOrderParams
      */
     outcomeId: string;
     /**
-     *
+     * Order side: buy or sell.
      * @type {string}
      * @memberof CreateOrderParams
      */
     side: CreateOrderParamsSideEnum;
     /**
-     *
+     * Order type: market (execute immediately) or limit (resting at a price).
      * @type {string}
      * @memberof CreateOrderParams
      */
     type: CreateOrderParamsTypeEnum;
     /**
-     *
+     * Size of the order in contracts/shares.
      * @type {number}
      * @memberof CreateOrderParams
      */

package/dist/esm/generated/src/models/EventFetchParams.d.ts

@@ -22,19 +22,19 @@ export interface EventFetchParams {
      */
     query?: string;
     /**
-     *
+     * Maximum number of results to return
      * @type {number}
      * @memberof EventFetchParams
      */
     limit?: number;
     /**
-     *
+     * Pagination offset — number of results to skip
      * @type {number}
      * @memberof EventFetchParams
      */
     offset?: number;
     /**
-     *
+     * Sort order for results
      * @type {string}
      * @memberof EventFetchParams
      */
@@ -46,7 +46,7 @@ export interface EventFetchParams {
      */
     status?: EventFetchParamsStatusEnum;
     /**
-     *
+     * Where to search (default: 'title')
      * @type {string}
      * @memberof EventFetchParams
      */

package/dist/esm/generated/src/models/ExchangeCredentials.d.ts

@@ -23,13 +23,13 @@ export interface ExchangeCredentials {
      */
     apiKey?: string;
     /**
-     *
+     * Standard API secret for HMAC-authenticated exchanges
      * @type {string}
      * @memberof ExchangeCredentials
      */
     apiSecret?: string;
     /**
-     *
+     * Standard API passphrase for HMAC-authenticated exchanges
      * @type {string}
      * @memberof ExchangeCredentials
      */

package/dist/esm/generated/src/models/HistoryFilterParams.d.ts

@@ -22,19 +22,19 @@ export interface HistoryFilterParams {
      */
     resolution?: HistoryFilterParamsResolutionEnum;
     /**
-     *
+     * Start of the time range
      * @type {Date}
      * @memberof HistoryFilterParams
      */
     start?: Date;
     /**
-     *
+     * End of the time range
      * @type {Date}
      * @memberof HistoryFilterParams
      */
     end?: Date;
     /**
-     *
+     * Maximum number of results to return
      * @type {number}
      * @memberof HistoryFilterParams
      */

package/dist/esm/generated/src/models/MarketFilterParams.d.ts

@@ -16,19 +16,19 @@
  */
 export interface MarketFilterParams {
     /**
-     *
+     * Maximum number of results to return
      * @type {number}
      * @memberof MarketFilterParams
      */
     limit?: number;
     /**
-     *
+     * Pagination offset — number of results to skip
      * @type {number}
      * @memberof MarketFilterParams
      */
     offset?: number;
     /**
-     *
+     * Sort order for results
      * @type {string}
      * @memberof MarketFilterParams
      */

package/dist/esm/generated/src/models/MarketOutcome.d.ts

@@ -28,19 +28,19 @@ export interface MarketOutcome {
      */
     marketId?: string;
     /**
-     *
+     * Human-readable outcome label (e.g., "Yes", "No", candidate name).
      * @type {string}
      * @memberof MarketOutcome
      */
     label: string;
     /**
-     *
+     * Probability between 0.0 and 1.0.
      * @type {number}
      * @memberof MarketOutcome
      */
     price: number;
     /**
-     *
+     * Change in price over the past 24 hours, as an absolute probability delta.
      * @type {number}
      * @memberof MarketOutcome
      */

package/dist/esm/generated/src/models/MyTradesParams.d.ts

@@ -28,19 +28,19 @@ export interface MyTradesParams {
      */
     marketId?: string;
     /**
-     *
+     * Only return records after this date
      * @type {Date}
      * @memberof MyTradesParams
      */
     since?: Date;
     /**
-     *
+     * Only return records before this date
      * @type {Date}
      * @memberof MyTradesParams
      */
     until?: Date;
     /**
-     *
+     * Maximum number of results to return
      * @type {number}
      * @memberof MyTradesParams
      */

package/dist/esm/generated/src/models/OHLCVParams.d.ts

@@ -22,19 +22,19 @@ export interface OHLCVParams {
      */
     resolution: OHLCVParamsResolutionEnum;
     /**
-     *
+     * Start of the time range
      * @type {Date}
      * @memberof OHLCVParams
      */
     start?: Date;
     /**
-     *
+     * End of the time range
      * @type {Date}
      * @memberof OHLCVParams
      */
     end?: Date;
     /**
-     *
+     * Maximum number of results to return
      * @type {number}
      * @memberof OHLCVParams
      */

package/dist/esm/generated/src/models/Order.d.ts

@@ -16,31 +16,31 @@
  */
 export interface Order {
     /**
-     *
+     * The exchange-assigned order identifier.
      * @type {string}
      * @memberof Order
      */
     id: string;
     /**
-     *
+     * The market this order was placed on.
      * @type {string}
      * @memberof Order
      */
     marketId: string;
     /**
-     *
+     * The outcome this order was placed on.
      * @type {string}
      * @memberof Order
      */
     outcomeId: string;
     /**
-     *
+     * Order side: buy or sell.
      * @type {string}
      * @memberof Order
      */
     side: OrderSideEnum;
     /**
-     *
+     * Order type: market (execute immediately) or limit (resting at a price).
      * @type {string}
      * @memberof Order
      */
@@ -58,7 +58,7 @@ export interface Order {
      */
     amount: number;
     /**
-     *
+     * Lifecycle status of the order.
      * @type {string}
      * @memberof Order
      */
@@ -76,13 +76,13 @@ export interface Order {
      */
     remaining: number;
     /**
-     *
+     * Unix timestamp in milliseconds when the order was created.
      * @type {number}
      * @memberof Order
      */
     timestamp: number;
     /**
-     *
+     * Fee paid for this order, if known.
      * @type {number}
      * @memberof Order
      */

package/dist/esm/generated/src/models/OrderBook.d.ts

@@ -17,19 +17,19 @@ import type { OrderLevel } from './OrderLevel.js';
  */
 export interface OrderBook {
     /**
-     *
+     * Order book bid levels, sorted by price descending.
      * @type {Array<OrderLevel>}
      * @memberof OrderBook
      */
     bids: Array<OrderLevel>;
     /**
-     *
+     * Order book ask levels, sorted by price ascending.
      * @type {Array<OrderLevel>}
      * @memberof OrderBook
      */
     asks: Array<OrderLevel>;
     /**
-     *
+     * Unix timestamp in milliseconds when the snapshot was taken.
      * @type {number}
      * @memberof OrderBook
      */

package/dist/esm/generated/src/models/OrderHistoryParams.d.ts

@@ -22,25 +22,25 @@ export interface OrderHistoryParams {
      */
     marketId?: string;
     /**
-     *
+     * Only return records after this date
      * @type {Date}
      * @memberof OrderHistoryParams
      */
     since?: Date;
     /**
-     *
+     * Only return records before this date
      * @type {Date}
      * @memberof OrderHistoryParams
      */
     until?: Date;
     /**
-     *
+     * Maximum number of results to return
      * @type {number}
      * @memberof OrderHistoryParams
      */
     limit?: number;
     /**
-     *
+     * Opaque pagination cursor from a previous response
      * @type {string}
      * @memberof OrderHistoryParams
      */

package/dist/esm/generated/src/models/PaginatedMarketsResult.d.ts

@@ -17,19 +17,19 @@ import type { UnifiedMarket } from './UnifiedMarket.js';
  */
 export interface PaginatedMarketsResult {
     /**
-     *
+     * The page of unified markets
      * @type {Array<UnifiedMarket>}
      * @memberof PaginatedMarketsResult
      */
     data: Array<UnifiedMarket>;
     /**
-     *
+     * Total number of markets in the snapshot
      * @type {number}
      * @memberof PaginatedMarketsResult
      */
     total: number;
     /**
-     *
+     * Cursor to pass to the next call, or undefined if this is the last page
      * @type {string}
      * @memberof PaginatedMarketsResult
      */

package/dist/esm/generated/src/models/Position.d.ts

@@ -16,19 +16,19 @@
  */
 export interface Position {
     /**
-     *
+     * The market this position is held in.
      * @type {string}
      * @memberof Position
      */
     marketId: string;
     /**
-     *
+     * The outcome this position is held in.
      * @type {string}
      * @memberof Position
      */
     outcomeId: string;
     /**
-     *
+     * Human-readable label for the outcome held.
      * @type {string}
      * @memberof Position
      */
@@ -40,25 +40,25 @@ export interface Position {
      */
     size: number;
     /**
-     *
+     * Average entry price for the position (probability between 0.0 and 1.0).
      * @type {number}
      * @memberof Position
      */
     entryPrice: number;
     /**
-     *
+     * Current mark price for the position (probability between 0.0 and 1.0).
      * @type {number}
      * @memberof Position
      */
     currentPrice: number;
     /**
-     *
+     * Unrealized profit or loss at the current price (USD).
      * @type {number}
      * @memberof Position
      */
     unrealizedPnL: number;
     /**
-     *
+     * Realized profit or loss booked so far (USD).
      * @type {number}
      * @memberof Position
      */

package/dist/esm/generated/src/models/PriceCandle.d.ts

@@ -16,37 +16,37 @@
  */
 export interface PriceCandle {
     /**
-     *
+     * Unix timestamp in milliseconds marking the start of the candle.
      * @type {number}
      * @memberof PriceCandle
      */
     timestamp: number;
     /**
-     *
+     * Opening price for the interval (probability between 0.0 and 1.0).
      * @type {number}
      * @memberof PriceCandle
      */
     open: number;
     /**
-     *
+     * Highest price during the interval (probability between 0.0 and 1.0).
      * @type {number}
      * @memberof PriceCandle
      */
     high: number;
     /**
-     *
+     * Lowest price during the interval (probability between 0.0 and 1.0).
      * @type {number}
      * @memberof PriceCandle
      */
     low: number;
     /**
-     *
+     * Closing price for the interval (probability between 0.0 and 1.0).
      * @type {number}
      * @memberof PriceCandle
      */
     close: number;
     /**
-     *
+     * Trading volume during the interval.
      * @type {number}
      * @memberof PriceCandle
      */

package/dist/esm/generated/src/models/Trade.d.ts

@@ -16,37 +16,37 @@
  */
 export interface Trade {
     /**
-     *
+     * The unique identifier for this trade.
      * @type {string}
      * @memberof Trade
      */
     id: string;
     /**
-     *
+     * Unix timestamp in milliseconds when the trade executed.
      * @type {number}
      * @memberof Trade
      */
     timestamp: number;
     /**
-     *
+     * Probability between 0.0 and 1.0.
      * @type {number}
      * @memberof Trade
      */
     price: number;
     /**
-     *
+     * Size of the trade in contracts/shares.
      * @type {number}
      * @memberof Trade
      */
     amount: number;
     /**
-     *
+     * Trade side from the taker's perspective.
      * @type {string}
      * @memberof Trade
      */
     side: TradeSideEnum;
     /**
-     *
+     * The outcome this trade is for (if known).
      * @type {string}
      * @memberof Trade
      */

package/dist/esm/generated/src/models/TradesParams.d.ts

@@ -16,19 +16,19 @@
  */
 export interface TradesParams {
     /**
-     *
+     * Start of the time range
      * @type {Date}
      * @memberof TradesParams
      */
     start?: Date;
     /**
-     *
+     * End of the time range
      * @type {Date}
      * @memberof TradesParams
      */
     end?: Date;
     /**
-     *
+     * Maximum number of results to return
      * @type {number}
      * @memberof TradesParams
      */

package/dist/esm/generated/src/models/UnifiedEvent.d.ts

@@ -17,37 +17,37 @@ import type { UnifiedMarket } from './UnifiedMarket.js';
  */
 export interface UnifiedEvent {
     /**
-     *
+     * The unique identifier for this event.
      * @type {string}
      * @memberof UnifiedEvent
      */
     id: string;
     /**
-     *
+     * The event title (e.g., "Who will be Fed Chair?").
      * @type {string}
      * @memberof UnifiedEvent
      */
     title: string;
     /**
-     *
+     * Long-form event description.
      * @type {string}
      * @memberof UnifiedEvent
      */
     description: string;
     /**
-     *
+     * URL-friendly slug for the event.
      * @type {string}
      * @memberof UnifiedEvent
      */
     slug: string;
     /**
-     *
+     * Markets grouped under this event.
      * @type {Array<UnifiedMarket>}
      * @memberof UnifiedEvent
      */
     markets: Array<UnifiedMarket>;
     /**
-     *
+     * Trading volume over the past 24 hours (USD).
      * @type {number}
      * @memberof UnifiedEvent
      */
@@ -59,25 +59,25 @@ export interface UnifiedEvent {
      */
     volume?: number;
     /**
-     *
+     * Canonical URL to view the event on the venue.
      * @type {string}
      * @memberof UnifiedEvent
      */
     url: string;
     /**
-     *
+     * Optional image URL for the event.
      * @type {string}
      * @memberof UnifiedEvent
      */
     image?: string;
     /**
-     *
+     * Optional category label (e.g., "Politics", "Sports").
      * @type {string}
      * @memberof UnifiedEvent
      */
     category?: string;
     /**
-     *
+     * Optional list of tags associated with the event.
      * @type {Array<string>}
      * @memberof UnifiedEvent
      */