pmxtjs 2.27.2 → 2.27.4

package/generated/docs/FilterMarketsRequestArgsInnerOneOfVolume24h.md

@@ -0,0 +1,36 @@
+
+# FilterMarketsRequestArgsInnerOneOfVolume24h
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`min` | number
+`max` | number
+
+## Example
+
+```typescript
+import type { FilterMarketsRequestArgsInnerOneOfVolume24h } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "min": null,
+  "max": null,
+} satisfies FilterMarketsRequestArgsInnerOneOfVolume24h
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FilterMarketsRequestArgsInnerOneOfVolume24h
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/generated/docs/PaginatedMarketsResult.md

@@ -1,6 +1,7 @@
 
 # PaginatedMarketsResult
 
+Shape returned by fetchMarketsPaginated
 
 ## Properties
 

package/generated/docs/Trade.md

@@ -7,10 +7,11 @@
 Name | Type
 ------------ | -------------
 `id` | string
+`timestamp` | number
 `price` | number
 `amount` | number
 `side` | string
-`timestamp` | number
+`outcomeId` | string
 
 ## Example
 
@@ -20,10 +21,11 @@ import type { Trade } from 'pmxtjs'
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
+  "timestamp": null,
   "price": null,
   "amount": null,
   "side": null,
-  "timestamp": null,
+  "outcomeId": null,
 } satisfies Trade
 
 console.log(example)

package/generated/docs/UnifiedEvent.md

@@ -1,7 +1,7 @@
 
 # UnifiedEvent
 
-A grouped collection of related markets (e.g., \"Who will be Fed Chair?\" contains multiple candidate markets)
+A grouped collection of related markets (e.g., \"Who will be Fed Chair?\" contains multiple candidate markets).
 
 ## Properties
 

package/generated/docs/UnifiedMarket.md

@@ -7,11 +7,11 @@
 Name | Type
 ------------ | -------------
 `marketId` | string
+`eventId` | string
 `title` | string
 `description` | string
 `slug` | string
 `outcomes` | [Array<MarketOutcome>](MarketOutcome.md)
-`eventId` | string
 `resolutionDate` | Date
 `volume24h` | number
 `volume` | number
@@ -37,11 +37,11 @@ import type { UnifiedMarket } from 'pmxtjs'
 // TODO: Update the object below with actual values
 const example = {
   "marketId": null,
+  "eventId": null,
   "title": null,
   "description": null,
   "slug": null,
   "outcomes": null,
-  "eventId": null,
   "resolutionDate": null,
   "volume24h": null,
   "volume": null,

package/generated/docs/UserTrade.md

@@ -7,13 +7,12 @@
 Name | Type
 ------------ | -------------
 `id` | string
+`timestamp` | number
 `price` | number
 `amount` | number
 `side` | string
-`timestamp` | number
-`orderId` | string
 `outcomeId` | string
-`marketId` | string
+`orderId` | string
 
 ## Example
 
@@ -23,13 +22,12 @@ import type { UserTrade } from 'pmxtjs'
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
+  "timestamp": null,
   "price": null,
   "amount": null,
   "side": null,
-  "timestamp": null,
-  "orderId": null,
   "outcomeId": null,
-  "marketId": null,
+  "orderId": null,
 } satisfies UserTrade
 
 console.log(example)

package/generated/package.json

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

package/generated/src/apis/DefaultApi.ts

@@ -167,9 +167,9 @@ export interface FetchClosedOrdersRequest {
 export interface FetchEventRequest {
     exchange: FetchEventExchangeEnum;
     query?: string;
-    sort?: FetchEventSortEnum;
     limit?: number;
     offset?: number;
+    sort?: FetchEventSortEnum;
     status?: FetchEventStatusEnum;
     searchIn?: FetchEventSearchInEnum;
     eventId?: string;
@@ -179,9 +179,9 @@ export interface FetchEventRequest {
 export interface FetchEventsRequest {
     exchange: FetchEventsExchangeEnum;
     query?: string;
-    sort?: FetchEventsSortEnum;
     limit?: number;
     offset?: number;
+    sort?: FetchEventsSortEnum;
     status?: FetchEventsStatusEnum;
     searchIn?: FetchEventsSearchInEnum;
     eventId?: string;
@@ -671,10 +671,6 @@ export class DefaultApi extends runtime.BaseAPI {
             queryParameters['query'] = requestParameters['query'];
         }
 
-        if (requestParameters['sort'] != null) {
-            queryParameters['sort'] = requestParameters['sort'];
-        }
-
         if (requestParameters['limit'] != null) {
             queryParameters['limit'] = requestParameters['limit'];
         }
@@ -683,6 +679,10 @@ export class DefaultApi extends runtime.BaseAPI {
             queryParameters['offset'] = requestParameters['offset'];
         }
 
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
         if (requestParameters['status'] != null) {
             queryParameters['status'] = requestParameters['status'];
         }
@@ -742,10 +742,6 @@ export class DefaultApi extends runtime.BaseAPI {
             queryParameters['query'] = requestParameters['query'];
         }
 
-        if (requestParameters['sort'] != null) {
-            queryParameters['sort'] = requestParameters['sort'];
-        }
-
         if (requestParameters['limit'] != null) {
             queryParameters['limit'] = requestParameters['limit'];
         }
@@ -754,6 +750,10 @@ export class DefaultApi extends runtime.BaseAPI {
             queryParameters['offset'] = requestParameters['offset'];
         }
 
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
         if (requestParameters['status'] != null) {
             queryParameters['status'] = requestParameters['status'];
         }
@@ -1992,6 +1992,7 @@ export type FetchEventSortEnum = typeof FetchEventSortEnum[keyof typeof FetchEve
  */
 export const FetchEventStatusEnum = {
     Active: 'active',
+    Inactive: 'inactive',
     Closed: 'closed',
     All: 'all'
 } as const;
@@ -2036,6 +2037,7 @@ export type FetchEventsSortEnum = typeof FetchEventsSortEnum[keyof typeof FetchE
  */
 export const FetchEventsStatusEnum = {
     Active: 'active',
+    Inactive: 'inactive',
     Closed: 'closed',
     All: 'all'
 } as const;
@@ -2080,6 +2082,7 @@ export type FetchMarketSortEnum = typeof FetchMarketSortEnum[keyof typeof FetchM
  */
 export const FetchMarketStatusEnum = {
     Active: 'active',
+    Inactive: 'inactive',
     Closed: 'closed',
     All: 'all'
 } as const;
@@ -2124,6 +2127,7 @@ export type FetchMarketsSortEnum = typeof FetchMarketsSortEnum[keyof typeof Fetc
  */
 export const FetchMarketsStatusEnum = {
     Active: 'active',
+    Inactive: 'inactive',
     Closed: 'closed',
     All: 'all'
 } as const;

package/generated/src/models/Balance.ts

@@ -20,35 +20,39 @@ import { mapValues } from '../runtime';
  */
 export interface Balance {
     /**
-     * 
+     * e.g., 'USDC'
      * @type {string}
      * @memberof Balance
      */
-    currency?: string;
+    currency: string;
     /**
      * 
      * @type {number}
      * @memberof Balance
      */
-    total?: number;
+    total: number;
     /**
      * 
      * @type {number}
      * @memberof Balance
      */
-    available?: number;
+    available: number;
     /**
-     * 
+     * In open orders
      * @type {number}
      * @memberof Balance
      */
-    locked?: number;
+    locked: number;
 }
 
 /**
  * Check if a given object implements the Balance interface.
  */
 export function instanceOfBalance(value: object): value is Balance {
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('available' in value) || value['available'] === undefined) return false;
+    if (!('locked' in value) || value['locked'] === undefined) return false;
     return true;
 }
 
@@ -62,10 +66,10 @@ export function BalanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): B
     }
     return {
         
-        'currency': json['currency'] == null ? undefined : json['currency'],
-        'total': json['total'] == null ? undefined : json['total'],
-        'available': json['available'] == null ? undefined : json['available'],
-        'locked': json['locked'] == null ? undefined : json['locked'],
+        'currency': json['currency'],
+        'total': json['total'],
+        'available': json['available'],
+        'locked': json['locked'],
     };
 }
 

package/generated/src/models/BuiltOrder.ts

@@ -29,25 +29,25 @@ import {
 } from './BuiltOrderTx';
 
 /**
- * An order built but not yet submitted, ready for inspection or middleware forwarding
+ * 
  * @export
  * @interface BuiltOrder
  */
 export interface BuiltOrder {
     /**
-     * The exchange name this order was built for
+     * The exchange name this order was built for.
      * @type {string}
      * @memberof BuiltOrder
      */
-    exchange?: string;
+    exchange: string;
     /**
-     * 
+     * The original params used to build this order.
      * @type {CreateOrderParams}
      * @memberof BuiltOrder
      */
-    params?: CreateOrderParams;
+    params: CreateOrderParams;
     /**
-     * For CLOB exchanges (Polymarket): the EIP-712 signed order ready to POST
+     * For CLOB exchanges (Polymarket): the EIP-712 signed order ready to POST to the exchange's order endpoint.
      * @type {{ [key: string]: any; }}
      * @memberof BuiltOrder
      */
@@ -63,13 +63,16 @@ export interface BuiltOrder {
      * @type {any}
      * @memberof BuiltOrder
      */
-    raw?: any | null;
+    raw: any | null;
 }
 
 /**
  * Check if a given object implements the BuiltOrder interface.
  */
 export function instanceOfBuiltOrder(value: object): value is BuiltOrder {
+    if (!('exchange' in value) || value['exchange'] === undefined) return false;
+    if (!('params' in value) || value['params'] === undefined) return false;
+    if (!('raw' in value) || value['raw'] === undefined) return false;
     return true;
 }
 
@@ -83,11 +86,11 @@ export function BuiltOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean)
     }
     return {
         
-        'exchange': json['exchange'] == null ? undefined : json['exchange'],
-        'params': json['params'] == null ? undefined : CreateOrderParamsFromJSON(json['params']),
+        'exchange': json['exchange'],
+        'params': CreateOrderParamsFromJSON(json['params']),
         'signedOrder': json['signedOrder'] == null ? undefined : json['signedOrder'],
         'tx': json['tx'] == null ? undefined : BuiltOrderTxFromJSON(json['tx']),
-        'raw': json['raw'] == null ? undefined : json['raw'],
+        'raw': json['raw'],
     };
 }
 

package/generated/src/models/BuiltOrderTx.ts

@@ -14,7 +14,7 @@
 
 import { mapValues } from '../runtime';
 /**
- * For on-chain AMM exchanges: the EVM transaction payload (reserved for future use)
+ * For on-chain AMM exchanges: the EVM transaction payload. Reserved for future exchanges; no current exchange populates this.
  * @export
  * @interface BuiltOrderTx
  */
@@ -24,31 +24,35 @@ export interface BuiltOrderTx {
      * @type {string}
      * @memberof BuiltOrderTx
      */
-    to?: string;
+    to: string;
     /**
      * 
      * @type {string}
      * @memberof BuiltOrderTx
      */
-    data?: string;
+    data: string;
     /**
      * 
      * @type {string}
      * @memberof BuiltOrderTx
      */
-    value?: string;
+    value: string;
     /**
      * 
      * @type {number}
      * @memberof BuiltOrderTx
      */
-    chainId?: number;
+    chainId: number;
 }
 
 /**
  * Check if a given object implements the BuiltOrderTx interface.
  */
 export function instanceOfBuiltOrderTx(value: object): value is BuiltOrderTx {
+    if (!('to' in value) || value['to'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
+    if (!('chainId' in value) || value['chainId'] === undefined) return false;
     return true;
 }
 
@@ -62,10 +66,10 @@ export function BuiltOrderTxFromJSONTyped(json: any, ignoreDiscriminator: boolea
     }
     return {
         
-        'to': json['to'] == null ? undefined : json['to'],
-        'data': json['data'] == null ? undefined : json['data'],
-        'value': json['value'] == null ? undefined : json['value'],
-        'chainId': json['chainId'] == null ? undefined : json['chainId'],
+        'to': json['to'],
+        'data': json['data'],
+        'value': json['value'],
+        'chainId': json['chainId'],
     };
 }
 

package/generated/src/models/CreateOrderParams.ts

@@ -50,13 +50,13 @@ export interface CreateOrderParams {
      */
     amount: number;
     /**
-     * 
+     * Required for limit orders
      * @type {number}
      * @memberof CreateOrderParams
      */
     price?: number;
     /**
-     * 
+     * Optional fee rate (e.g., 1000 for 0.1%)
      * @type {number}
      * @memberof CreateOrderParams
      */
@@ -89,8 +89,8 @@ export type CreateOrderParamsSideEnum = typeof CreateOrderParamsSideEnum[keyof t
  * @export
  */
 export const CreateOrderParamsTypeEnum = {
-    Limit: 'limit',
-    Market: 'market'
+    Market: 'market',
+    Limit: 'limit'
 } as const;
 export type CreateOrderParamsTypeEnum = typeof CreateOrderParamsTypeEnum[keyof typeof CreateOrderParamsTypeEnum];
 

package/generated/src/models/EventFetchParams.ts

@@ -20,31 +20,31 @@ import { mapValues } from '../runtime';
  */
 export interface EventFetchParams {
     /**
-     * 
+     * For keyword search
      * @type {string}
      * @memberof EventFetchParams
      */
     query?: string;
     /**
      * 
-     * @type {string}
+     * @type {number}
      * @memberof EventFetchParams
      */
-    sort?: EventFetchParamsSortEnum;
+    limit?: number;
     /**
      * 
      * @type {number}
      * @memberof EventFetchParams
      */
-    limit?: number;
+    offset?: number;
     /**
      * 
-     * @type {number}
+     * @type {string}
      * @memberof EventFetchParams
      */
-    offset?: number;
+    sort?: EventFetchParamsSortEnum;
     /**
-     * Filter by event status (default: active)
+     * Filter by event status (default: 'active', 'inactive' and 'closed' are interchangeable)
      * @type {string}
      * @memberof EventFetchParams
      */
@@ -85,6 +85,7 @@ export type EventFetchParamsSortEnum = typeof EventFetchParamsSortEnum[keyof typ
  */
 export const EventFetchParamsStatusEnum = {
     Active: 'active',
+    Inactive: 'inactive',
     Closed: 'closed',
     All: 'all'
 } as const;
@@ -119,9 +120,9 @@ export function EventFetchParamsFromJSONTyped(json: any, ignoreDiscriminator: bo
     return {
         
         'query': json['query'] == null ? undefined : json['query'],
-        'sort': json['sort'] == null ? undefined : json['sort'],
         'limit': json['limit'] == null ? undefined : json['limit'],
         'offset': json['offset'] == null ? undefined : json['offset'],
+        'sort': json['sort'] == null ? undefined : json['sort'],
         'status': json['status'] == null ? undefined : json['status'],
         'searchIn': json['searchIn'] == null ? undefined : json['searchIn'],
         'eventId': json['eventId'] == null ? undefined : json['eventId'],
@@ -141,9 +142,9 @@ export function EventFetchParamsToJSONTyped(value?: EventFetchParams | null, ign
     return {
         
         'query': value['query'],
-        'sort': value['sort'],
         'limit': value['limit'],
         'offset': value['offset'],
+        'sort': value['sort'],
         'status': value['status'],
         'searchIn': value['searchIn'],
         'eventId': value['eventId'],

package/generated/src/models/ExchangeCredentials.ts

@@ -22,47 +22,53 @@ import {
 } from './ExchangeCredentialsSignatureType';
 
 /**
- * Optional authentication credentials for exchange operations
+ * Optional authentication credentials for exchange operations.
  * @export
  * @interface ExchangeCredentials
  */
 export interface ExchangeCredentials {
     /**
-     * API key for the exchange
+     * 
      * @type {string}
      * @memberof ExchangeCredentials
      */
     apiKey?: string;
     /**
-     * Private key for signing transactions
+     * 
      * @type {string}
      * @memberof ExchangeCredentials
      */
-    privateKey?: string;
+    apiSecret?: string;
     /**
-     * API secret (if required by exchange)
+     * 
      * @type {string}
      * @memberof ExchangeCredentials
      */
-    apiSecret?: string;
+    passphrase?: string;
     /**
-     * Passphrase (if required by exchange)
+     * Metaculus: `Authorization: Token <apiToken>` for higher rate limits
      * @type {string}
      * @memberof ExchangeCredentials
      */
-    passphrase?: string;
+    apiToken?: string;
     /**
-     * The address funding the trades (Proxy address)
+     * Required for Polymarket L1 auth
      * @type {string}
      * @memberof ExchangeCredentials
      */
-    funderAddress?: string;
+    privateKey?: string;
     /**
      * 
      * @type {ExchangeCredentialsSignatureType}
      * @memberof ExchangeCredentials
      */
     signatureType?: ExchangeCredentialsSignatureType;
+    /**
+     * The address funding the trades (defaults to signer address)
+     * @type {string}
+     * @memberof ExchangeCredentials
+     */
+    funderAddress?: string;
 }
 
 /**
@@ -83,11 +89,12 @@ export function ExchangeCredentialsFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'apiKey': json['apiKey'] == null ? undefined : json['apiKey'],
-        'privateKey': json['privateKey'] == null ? undefined : json['privateKey'],
         'apiSecret': json['apiSecret'] == null ? undefined : json['apiSecret'],
         'passphrase': json['passphrase'] == null ? undefined : json['passphrase'],
-        'funderAddress': json['funderAddress'] == null ? undefined : json['funderAddress'],
+        'apiToken': json['apiToken'] == null ? undefined : json['apiToken'],
+        'privateKey': json['privateKey'] == null ? undefined : json['privateKey'],
         'signatureType': json['signatureType'] == null ? undefined : ExchangeCredentialsSignatureTypeFromJSON(json['signatureType']),
+        'funderAddress': json['funderAddress'] == null ? undefined : json['funderAddress'],
     };
 }
 
@@ -103,11 +110,12 @@ export function ExchangeCredentialsToJSONTyped(value?: ExchangeCredentials | nul
     return {
         
         'apiKey': value['apiKey'],
-        'privateKey': value['privateKey'],
         'apiSecret': value['apiSecret'],
         'passphrase': value['passphrase'],
-        'funderAddress': value['funderAddress'],
+        'apiToken': value['apiToken'],
+        'privateKey': value['privateKey'],
         'signatureType': ExchangeCredentialsSignatureTypeToJSON(value['signatureType']),
+        'funderAddress': value['funderAddress'],
     };
 }
 

package/generated/src/models/ExchangeCredentialsSignatureType.ts

@@ -14,7 +14,7 @@
 
 /**
  * @type ExchangeCredentialsSignatureType
- * Signature type (0=EOA, 1=Poly Proxy, 2=Gnosis Safe, or names like 'gnosis_safe')
+ * 0 = EOA, 1 = Poly Proxy, 2 = Gnosis Safe (Can also use 'eoa', 'polyproxy', 'gnosis_safe')
  * @export
  */
 export type ExchangeCredentialsSignatureType = number | string;

package/generated/src/models/ExecutionPriceResult.ts

@@ -24,25 +24,28 @@ export interface ExecutionPriceResult {
      * @type {number}
      * @memberof ExecutionPriceResult
      */
-    price?: number;
+    price: number;
     /**
      * 
      * @type {number}
      * @memberof ExecutionPriceResult
      */
-    filledAmount?: number;
+    filledAmount: number;
     /**
      * 
      * @type {boolean}
      * @memberof ExecutionPriceResult
      */
-    fullyFilled?: boolean;
+    fullyFilled: boolean;
 }
 
 /**
  * Check if a given object implements the ExecutionPriceResult interface.
  */
 export function instanceOfExecutionPriceResult(value: object): value is ExecutionPriceResult {
+    if (!('price' in value) || value['price'] === undefined) return false;
+    if (!('filledAmount' in value) || value['filledAmount'] === undefined) return false;
+    if (!('fullyFilled' in value) || value['fullyFilled'] === undefined) return false;
     return true;
 }
 
@@ -56,9 +59,9 @@ export function ExecutionPriceResultFromJSONTyped(json: any, ignoreDiscriminator
     }
     return {
         
-        'price': json['price'] == null ? undefined : json['price'],
-        'filledAmount': json['filledAmount'] == null ? undefined : json['filledAmount'],
-        'fullyFilled': json['fullyFilled'] == null ? undefined : json['fullyFilled'],
+        'price': json['price'],
+        'filledAmount': json['filledAmount'],
+        'fullyFilled': json['fullyFilled'],
     };
 }