pmxtjs 2.27.4 → 2.27.5

package/dist/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/generated/src/models/UnifiedEvent.d.ts

@@ -17,37 +17,37 @@ import type { UnifiedMarket } from './UnifiedMarket';
  */
 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
      */

package/dist/generated/src/models/UnifiedMarket.d.ts

@@ -29,37 +29,37 @@ export interface UnifiedMarket {
      */
     eventId?: string;
     /**
-     *
+     * The market title (e.g., "Will BTC close above $100k on Dec 31?").
      * @type {string}
      * @memberof UnifiedMarket
      */
     title: string;
     /**
-     *
+     * Long-form market description or resolution criteria.
      * @type {string}
      * @memberof UnifiedMarket
      */
     description: string;
     /**
-     *
+     * URL-friendly slug for the market.
      * @type {string}
      * @memberof UnifiedMarket
      */
     slug?: string;
     /**
-     *
+     * The possible outcomes for this market.
      * @type {Array<MarketOutcome>}
      * @memberof UnifiedMarket
      */
     outcomes: Array<MarketOutcome>;
     /**
-     *
+     * When the market is scheduled to resolve.
      * @type {Date}
      * @memberof UnifiedMarket
      */
     resolutionDate: Date;
     /**
-     *
+     * Trading volume over the past 24 hours (USD).
      * @type {number}
      * @memberof UnifiedMarket
      */
@@ -71,37 +71,37 @@ export interface UnifiedMarket {
      */
     volume?: number;
     /**
-     *
+     * Current market liquidity (USD).
      * @type {number}
      * @memberof UnifiedMarket
      */
     liquidity: number;
     /**
-     *
+     * Total value of outstanding contracts (USD).
      * @type {number}
      * @memberof UnifiedMarket
      */
     openInterest?: number;
     /**
-     *
+     * Canonical URL to view the market on the venue.
      * @type {string}
      * @memberof UnifiedMarket
      */
     url: string;
     /**
-     *
+     * Optional image URL for the market.
      * @type {string}
      * @memberof UnifiedMarket
      */
     image?: string;
     /**
-     *
+     * Optional category label (e.g., "Politics", "Crypto").
      * @type {string}
      * @memberof UnifiedMarket
      */
     category?: string;
     /**
-     *
+     * Optional list of tags associated with the market.
      * @type {Array<string>}
      * @memberof UnifiedMarket
      */
@@ -125,25 +125,25 @@ export interface UnifiedMarket {
      */
     contractAddress?: string;
     /**
-     *
+     * Convenience accessor for the YES outcome on a binary market.
      * @type {MarketOutcome}
      * @memberof UnifiedMarket
      */
     yes?: MarketOutcome;
     /**
-     *
+     * Convenience accessor for the NO outcome on a binary market.
      * @type {MarketOutcome}
      * @memberof UnifiedMarket
      */
     no?: MarketOutcome;
     /**
-     *
+     * Convenience accessor for the UP outcome on a binary market.
      * @type {MarketOutcome}
      * @memberof UnifiedMarket
      */
     up?: MarketOutcome;
     /**
-     *
+     * Convenience accessor for the DOWN outcome on a binary market.
      * @type {MarketOutcome}
      * @memberof UnifiedMarket
      */

package/dist/generated/src/models/UserTrade.d.ts

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

package/generated/docs/DefaultApi.md

@@ -341,13 +341,13 @@ async function example() {
     exchange: exchange_example,
     // string | required for Limitless (slug) (optional)
     marketId: marketId_example,
-    // Date (optional)
+    // Date | Only return records after this date (optional)
     since: 2013-10-20T19:20:30+01:00,
-    // Date (optional)
+    // Date | Only return records before this date (optional)
     until: 2013-10-20T19:20:30+01:00,
-    // number (optional)
+    // number | Maximum number of results to return (optional)
     limit: 8.14,
-    // string (optional)
+    // string | Opaque pagination cursor from a previous response (optional)
     cursor: cursor_example,
   } satisfies FetchAllOrdersRequest;
 
@@ -370,10 +370,10 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
 | **marketId** | `string` | required for Limitless (slug) | [Optional] [Defaults to `undefined`] |
-| **since** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **until** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **cursor** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **since** | `Date` | Only return records after this date | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Only return records before this date | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
+| **cursor** | `string` | Opaque pagination cursor from a previous response | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -491,13 +491,13 @@ async function example() {
     exchange: exchange_example,
     // string | required for Limitless (slug) (optional)
     marketId: marketId_example,
-    // Date (optional)
+    // Date | Only return records after this date (optional)
     since: 2013-10-20T19:20:30+01:00,
-    // Date (optional)
+    // Date | Only return records before this date (optional)
     until: 2013-10-20T19:20:30+01:00,
-    // number (optional)
+    // number | Maximum number of results to return (optional)
     limit: 8.14,
-    // string (optional)
+    // string | Opaque pagination cursor from a previous response (optional)
     cursor: cursor_example,
   } satisfies FetchClosedOrdersRequest;
 
@@ -520,10 +520,10 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
 | **marketId** | `string` | required for Limitless (slug) | [Optional] [Defaults to `undefined`] |
-| **since** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **until** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **cursor** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **since** | `Date` | Only return records after this date | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Only return records before this date | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
+| **cursor** | `string` | Opaque pagination cursor from a previous response | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -573,15 +573,15 @@ async function example() {
     exchange: exchange_example,
     // string | For keyword search (optional)
     query: query_example,
-    // number (optional)
+    // number | Maximum number of results to return (optional)
     limit: 8.14,
-    // number (optional)
+    // number | Pagination offset — number of results to skip (optional)
     offset: 8.14,
-    // 'volume' | 'liquidity' | 'newest' (optional)
+    // 'volume' | 'liquidity' | 'newest' | Sort order for results (optional)
     sort: sort_example,
     // 'active' | 'inactive' | 'closed' | 'all' | Filter by event status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) (optional)
     status: status_example,
-    // 'title' | 'description' | 'both' (optional)
+    // 'title' | 'description' | 'both' | Where to search (default: \'title\') (optional)
     searchIn: searchIn_example,
     // string | Direct lookup by event ID (optional)
     eventId: eventId_example,
@@ -608,11 +608,11 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
 | **query** | `string` | For keyword search | [Optional] [Defaults to `undefined`] |
-| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **offset** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **sort** | `volume`, `liquidity`, `newest` |  | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
+| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Pagination offset — number of results to skip | [Optional] [Defaults to `undefined`] |
+| **sort** | `volume`, `liquidity`, `newest` | Sort order for results | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
 | **status** | `active`, `inactive`, `closed`, `all` | Filter by event status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) | [Optional] [Defaults to `undefined`] [Enum: active, inactive, closed, all] |
-| **searchIn** | `title`, `description`, `both` |  | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
+| **searchIn** | `title`, `description`, `both` | Where to search (default: \'title\') | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
 | **eventId** | `string` | Direct lookup by event ID | [Optional] [Defaults to `undefined`] |
 | **slug** | `string` | Lookup by event slug | [Optional] [Defaults to `undefined`] |
 
@@ -664,15 +664,15 @@ async function example() {
     exchange: exchange_example,
     // string | For keyword search (optional)
     query: query_example,
-    // number (optional)
+    // number | Maximum number of results to return (optional)
     limit: 8.14,
-    // number (optional)
+    // number | Pagination offset — number of results to skip (optional)
     offset: 8.14,
-    // 'volume' | 'liquidity' | 'newest' (optional)
+    // 'volume' | 'liquidity' | 'newest' | Sort order for results (optional)
     sort: sort_example,
     // 'active' | 'inactive' | 'closed' | 'all' | Filter by event status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) (optional)
     status: status_example,
-    // 'title' | 'description' | 'both' (optional)
+    // 'title' | 'description' | 'both' | Where to search (default: \'title\') (optional)
     searchIn: searchIn_example,
     // string | Direct lookup by event ID (optional)
     eventId: eventId_example,
@@ -699,11 +699,11 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
 | **query** | `string` | For keyword search | [Optional] [Defaults to `undefined`] |
-| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **offset** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **sort** | `volume`, `liquidity`, `newest` |  | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
+| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Pagination offset — number of results to skip | [Optional] [Defaults to `undefined`] |
+| **sort** | `volume`, `liquidity`, `newest` | Sort order for results | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
 | **status** | `active`, `inactive`, `closed`, `all` | Filter by event status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) | [Optional] [Defaults to `undefined`] [Enum: active, inactive, closed, all] |
-| **searchIn** | `title`, `description`, `both` |  | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
+| **searchIn** | `title`, `description`, `both` | Where to search (default: \'title\') | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
 | **eventId** | `string` | Direct lookup by event ID | [Optional] [Defaults to `undefined`] |
 | **slug** | `string` | Lookup by event slug | [Optional] [Defaults to `undefined`] |
 
@@ -753,11 +753,11 @@ async function example() {
   const body = {
     // 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | The prediction market exchange to target.
     exchange: exchange_example,
-    // number (optional)
+    // number | Maximum number of results to return (optional)
     limit: 8.14,
-    // number (optional)
+    // number | Pagination offset — number of results to skip (optional)
     offset: 8.14,
-    // 'volume' | 'liquidity' | 'newest' (optional)
+    // 'volume' | 'liquidity' | 'newest' | Sort order for results (optional)
     sort: sort_example,
     // 'active' | 'inactive' | 'closed' | 'all' | Filter by market status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) (optional)
     status: status_example,
@@ -797,9 +797,9 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
-| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **offset** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **sort** | `volume`, `liquidity`, `newest` |  | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
+| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Pagination offset — number of results to skip | [Optional] [Defaults to `undefined`] |
+| **sort** | `volume`, `liquidity`, `newest` | Sort order for results | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
 | **status** | `active`, `inactive`, `closed`, `all` | Filter by market status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) | [Optional] [Defaults to `undefined`] [Enum: active, inactive, closed, all] |
 | **searchIn** | `title`, `description`, `both` | Where to search (default: \'title\') | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
 | **query** | `string` | For keyword search | [Optional] [Defaults to `undefined`] |
@@ -856,11 +856,11 @@ async function example() {
   const body = {
     // 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | The prediction market exchange to target.
     exchange: exchange_example,
-    // number (optional)
+    // number | Maximum number of results to return (optional)
     limit: 8.14,
-    // number (optional)
+    // number | Pagination offset — number of results to skip (optional)
     offset: 8.14,
-    // 'volume' | 'liquidity' | 'newest' (optional)
+    // 'volume' | 'liquidity' | 'newest' | Sort order for results (optional)
     sort: sort_example,
     // 'active' | 'inactive' | 'closed' | 'all' | Filter by market status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) (optional)
     status: status_example,
@@ -900,9 +900,9 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
-| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **offset** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **sort** | `volume`, `liquidity`, `newest` |  | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
+| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Pagination offset — number of results to skip | [Optional] [Defaults to `undefined`] |
+| **sort** | `volume`, `liquidity`, `newest` | Sort order for results | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
 | **status** | `active`, `inactive`, `closed`, `all` | Filter by market status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) | [Optional] [Defaults to `undefined`] [Enum: active, inactive, closed, all] |
 | **searchIn** | `title`, `description`, `both` | Where to search (default: \'title\') | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
 | **query** | `string` | For keyword search | [Optional] [Defaults to `undefined`] |
@@ -1034,11 +1034,11 @@ async function example() {
     outcomeId: outcomeId_example,
     // string | filter to specific market (optional)
     marketId: marketId_example,
-    // Date (optional)
+    // Date | Only return records after this date (optional)
     since: 2013-10-20T19:20:30+01:00,
-    // Date (optional)
+    // Date | Only return records before this date (optional)
     until: 2013-10-20T19:20:30+01:00,
-    // number (optional)
+    // number | Maximum number of results to return (optional)
     limit: 8.14,
     // string | for Kalshi cursor pagination (optional)
     cursor: cursor_example,
@@ -1064,9 +1064,9 @@ example().catch(console.error);
 | **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
 | **outcomeId** | `string` | filter to specific outcome/ticker | [Optional] [Defaults to `undefined`] |
 | **marketId** | `string` | filter to specific market | [Optional] [Defaults to `undefined`] |
-| **since** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **until** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **since** | `Date` | Only return records after this date | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Only return records before this date | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
 | **cursor** | `string` | for Kalshi cursor pagination | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -1119,11 +1119,11 @@ async function example() {
     id: id_example,
     // '1m' | '5m' | '15m' | '1h' | '6h' | '1d' | Required for candle aggregation (optional)
     resolution: resolution_example,
-    // Date (optional)
+    // Date | Start of the time range (optional)
     start: 2013-10-20T19:20:30+01:00,
-    // Date (optional)
+    // Date | End of the time range (optional)
     end: 2013-10-20T19:20:30+01:00,
-    // number (optional)
+    // number | Maximum number of results to return (optional)
     limit: 8.14,
   } satisfies FetchOHLCVRequest;
 
@@ -1147,9 +1147,9 @@ example().catch(console.error);
 | **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
 | **id** | `string` |  | [Defaults to `undefined`] |
 | **resolution** | `1m`, `5m`, `15m`, `1h`, `6h`, `1d` | Required for candle aggregation | [Optional] [Defaults to `undefined`] [Enum: 1m, 5m, 15m, 1h, 6h, 1d] |
-| **start** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **end** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **start** | `Date` | Start of the time range | [Optional] [Defaults to `undefined`] |
+| **end** | `Date` | End of the time range | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -1479,11 +1479,11 @@ async function example() {
     exchange: exchange_example,
     // string
     id: id_example,
-    // Date (optional)
+    // Date | Start of the time range (optional)
     start: 2013-10-20T19:20:30+01:00,
-    // Date (optional)
+    // Date | End of the time range (optional)
     end: 2013-10-20T19:20:30+01:00,
-    // number (optional)
+    // number | Maximum number of results to return (optional)
     limit: 8.14,
   } satisfies FetchTradesRequest;
 
@@ -1506,9 +1506,9 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
 | **id** | `string` |  | [Defaults to `undefined`] |
-| **start** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **end** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **start** | `Date` | Start of the time range | [Optional] [Defaults to `undefined`] |
+| **end** | `Date` | End of the time range | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 

package/generated/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmxtjs",
-  "version": "2.27.4",
+  "version": "2.27.5",
   "description": "OpenAPI client for pmxtjs",
   "author": "OpenAPI-Generator",
   "repository": {

package/generated/src/models/Balance.ts

@@ -26,13 +26,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/generated/src/models/CreateOrderParams.ts

@@ -20,31 +20,31 @@ import { mapValues } from '../runtime';
  */
 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/generated/src/models/EventFetchParams.ts

@@ -26,19 +26,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
      */
@@ -50,7 +50,7 @@ export interface EventFetchParams {
      */
     status?: EventFetchParamsStatusEnum;
     /**
-     * 
+     * Where to search (default: 'title')
      * @type {string}
      * @memberof EventFetchParams
      */

package/generated/src/models/ExchangeCredentials.ts

@@ -34,13 +34,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
      */