pmxtjs 0.4.3 → 1.0.0-b2

package/README.md

@@ -0,0 +1,161 @@
+# pmxtjs@0.0.1
+
+A TypeScript SDK client for the localhost API.
+
+## Usage
+
+First, install the SDK from npm.
+
+```bash
+npm install pmxtjs --save
+```
+
+Next, try it out.
+
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from 'pmxtjs';
+import type { CancelOrderOperationRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DefaultApi();
+
+  const body = {
+    // 'polymarket' | 'kalshi' | The prediction market exchange to target.
+    exchange: exchange_example,
+    // CancelOrderRequest (optional)
+    cancelOrderRequest: ...,
+  } satisfies CancelOrderOperationRequest;
+
+  try {
+    const data = await api.cancelOrder(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+
+## Documentation
+
+### API Endpoints
+
+All URIs are relative to *http://localhost:3847*
+
+| Class | Method | HTTP request | Description
+| ----- | ------ | ------------ | -------------
+*DefaultApi* | [**cancelOrder**](docs/DefaultApi.md#cancelorderoperation) | **POST** /api/{exchange}/cancelOrder | Cancel Order
+*DefaultApi* | [**createOrder**](docs/DefaultApi.md#createorderoperation) | **POST** /api/{exchange}/createOrder | Create Order
+*DefaultApi* | [**fetchBalance**](docs/DefaultApi.md#fetchbalance) | **POST** /api/{exchange}/fetchBalance | Fetch Balance
+*DefaultApi* | [**fetchMarkets**](docs/DefaultApi.md#fetchmarketsoperation) | **POST** /api/{exchange}/fetchMarkets | Fetch Markets
+*DefaultApi* | [**fetchOHLCV**](docs/DefaultApi.md#fetchohlcvoperation) | **POST** /api/{exchange}/fetchOHLCV | Fetch OHLCV Candles
+*DefaultApi* | [**fetchOpenOrders**](docs/DefaultApi.md#fetchopenordersoperation) | **POST** /api/{exchange}/fetchOpenOrders | Fetch Open Orders
+*DefaultApi* | [**fetchOrder**](docs/DefaultApi.md#fetchorder) | **POST** /api/{exchange}/fetchOrder | Fetch Order
+*DefaultApi* | [**fetchOrderBook**](docs/DefaultApi.md#fetchorderbookoperation) | **POST** /api/{exchange}/fetchOrderBook | Fetch Order Book
+*DefaultApi* | [**fetchPositions**](docs/DefaultApi.md#fetchpositionsoperation) | **POST** /api/{exchange}/fetchPositions | Fetch Positions
+*DefaultApi* | [**fetchTrades**](docs/DefaultApi.md#fetchtradesoperation) | **POST** /api/{exchange}/fetchTrades | Fetch Trades
+*DefaultApi* | [**getMarketsBySlug**](docs/DefaultApi.md#getmarketsbyslugoperation) | **POST** /api/{exchange}/getMarketsBySlug | Get Market by Slug
+*DefaultApi* | [**healthCheck**](docs/DefaultApi.md#healthcheck) | **GET** /health | Server Health Check
+*DefaultApi* | [**searchMarkets**](docs/DefaultApi.md#searchmarketsoperation) | **POST** /api/{exchange}/searchMarkets | Search Markets
+
+
+### Models
+
+- [Balance](docs/Balance.md)
+- [BaseResponse](docs/BaseResponse.md)
+- [CancelOrderRequest](docs/CancelOrderRequest.md)
+- [CreateOrder200Response](docs/CreateOrder200Response.md)
+- [CreateOrderParams](docs/CreateOrderParams.md)
+- [CreateOrderRequest](docs/CreateOrderRequest.md)
+- [ErrorDetail](docs/ErrorDetail.md)
+- [ErrorResponse](docs/ErrorResponse.md)
+- [FetchBalance200Response](docs/FetchBalance200Response.md)
+- [FetchMarkets200Response](docs/FetchMarkets200Response.md)
+- [FetchMarketsRequest](docs/FetchMarketsRequest.md)
+- [FetchOHLCV200Response](docs/FetchOHLCV200Response.md)
+- [FetchOHLCVRequest](docs/FetchOHLCVRequest.md)
+- [FetchOHLCVRequestArgsInner](docs/FetchOHLCVRequestArgsInner.md)
+- [FetchOpenOrders200Response](docs/FetchOpenOrders200Response.md)
+- [FetchOpenOrdersRequest](docs/FetchOpenOrdersRequest.md)
+- [FetchOrderBook200Response](docs/FetchOrderBook200Response.md)
+- [FetchOrderBookRequest](docs/FetchOrderBookRequest.md)
+- [FetchPositions200Response](docs/FetchPositions200Response.md)
+- [FetchPositionsRequest](docs/FetchPositionsRequest.md)
+- [FetchTrades200Response](docs/FetchTrades200Response.md)
+- [FetchTradesRequest](docs/FetchTradesRequest.md)
+- [GetMarketsBySlugRequest](docs/GetMarketsBySlugRequest.md)
+- [HealthCheck200Response](docs/HealthCheck200Response.md)
+- [HistoryFilterParams](docs/HistoryFilterParams.md)
+- [MarketFilterParams](docs/MarketFilterParams.md)
+- [MarketOutcome](docs/MarketOutcome.md)
+- [Order](docs/Order.md)
+- [OrderBook](docs/OrderBook.md)
+- [OrderLevel](docs/OrderLevel.md)
+- [Position](docs/Position.md)
+- [PriceCandle](docs/PriceCandle.md)
+- [SearchMarketsRequest](docs/SearchMarketsRequest.md)
+- [SearchMarketsRequestArgsInner](docs/SearchMarketsRequestArgsInner.md)
+- [Trade](docs/Trade.md)
+- [UnifiedMarket](docs/UnifiedMarket.md)
+
+### Authorization
+
+Endpoints do not require authorization.
+
+
+## About
+
+This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
+and is automatically generated by the
+[OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: `0.4.4`
+- Package version: `0.0.1`
+- Generator version: `7.18.0`
+- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
+
+The generated npm module supports the following:
+
+- Environments
+  * Node.js
+  * Webpack
+  * Browserify
+- Language levels
+  * ES5 - you must have a Promises/A+ library installed
+  * ES6
+- Module systems
+  * CommonJS
+  * ES6 module system
+
+
+## Development
+
+### Building
+
+To build the TypeScript source code, you need to have Node.js and npm installed.
+After cloning the repository, navigate to the project directory and run:
+
+```bash
+npm install
+npm run build
+```
+
+### Publishing
+
+Once you've built the package, you can publish it to npm:
+
+```bash
+npm publish
+```
+
+## License
+
+[]()

package/dist/esm/generated/src/apis/DefaultApi.d.ts

@@ -0,0 +1,268 @@
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi). This API acts as a JSON-RPC-style gateway. Each endpoint corresponds to a specific method on the generic exchange implementation.
+ *
+ * The version of the OpenAPI document: 0.4.4
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CancelOrderRequest, CreateOrder200Response, CreateOrderRequest, FetchBalance200Response, FetchMarkets200Response, FetchMarketsRequest, FetchOHLCV200Response, FetchOHLCVRequest, FetchOpenOrders200Response, FetchOpenOrdersRequest, FetchOrderBook200Response, FetchOrderBookRequest, FetchPositions200Response, FetchPositionsRequest, FetchTrades200Response, FetchTradesRequest, GetMarketsBySlugRequest, HealthCheck200Response, SearchMarketsRequest } from '../models/index';
+export interface CancelOrderOperationRequest {
+    exchange: CancelOrderOperationExchangeEnum;
+    cancelOrderRequest?: CancelOrderRequest;
+}
+export interface CreateOrderOperationRequest {
+    exchange: CreateOrderOperationExchangeEnum;
+    createOrderRequest?: CreateOrderRequest;
+}
+export interface FetchBalanceRequest {
+    exchange: FetchBalanceExchangeEnum;
+    fetchPositionsRequest?: FetchPositionsRequest;
+}
+export interface FetchMarketsOperationRequest {
+    exchange: FetchMarketsOperationExchangeEnum;
+    fetchMarketsRequest?: FetchMarketsRequest;
+}
+export interface FetchOHLCVOperationRequest {
+    exchange: FetchOHLCVOperationExchangeEnum;
+    fetchOHLCVRequest?: FetchOHLCVRequest;
+}
+export interface FetchOpenOrdersOperationRequest {
+    exchange: FetchOpenOrdersOperationExchangeEnum;
+    fetchOpenOrdersRequest?: FetchOpenOrdersRequest;
+}
+export interface FetchOrderRequest {
+    exchange: FetchOrderExchangeEnum;
+    cancelOrderRequest?: CancelOrderRequest;
+}
+export interface FetchOrderBookOperationRequest {
+    exchange: FetchOrderBookOperationExchangeEnum;
+    fetchOrderBookRequest?: FetchOrderBookRequest;
+}
+export interface FetchPositionsOperationRequest {
+    exchange: FetchPositionsOperationExchangeEnum;
+    fetchPositionsRequest?: FetchPositionsRequest;
+}
+export interface FetchTradesOperationRequest {
+    exchange: FetchTradesOperationExchangeEnum;
+    fetchTradesRequest?: FetchTradesRequest;
+}
+export interface GetMarketsBySlugOperationRequest {
+    exchange: GetMarketsBySlugOperationExchangeEnum;
+    getMarketsBySlugRequest?: GetMarketsBySlugRequest;
+}
+export interface SearchMarketsOperationRequest {
+    exchange: SearchMarketsOperationExchangeEnum;
+    searchMarketsRequest?: SearchMarketsRequest;
+}
+/**
+ *
+ */
+export declare class DefaultApi extends runtime.BaseAPI {
+    /**
+     * Cancel Order
+     */
+    cancelOrderRaw(requestParameters: CancelOrderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateOrder200Response>>;
+    /**
+     * Cancel Order
+     */
+    cancelOrder(requestParameters: CancelOrderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateOrder200Response>;
+    /**
+     * Create Order
+     */
+    createOrderRaw(requestParameters: CreateOrderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateOrder200Response>>;
+    /**
+     * Create Order
+     */
+    createOrder(requestParameters: CreateOrderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateOrder200Response>;
+    /**
+     * Fetch Balance
+     */
+    fetchBalanceRaw(requestParameters: FetchBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchBalance200Response>>;
+    /**
+     * Fetch Balance
+     */
+    fetchBalance(requestParameters: FetchBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchBalance200Response>;
+    /**
+     * Fetch Markets
+     */
+    fetchMarketsRaw(requestParameters: FetchMarketsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchMarkets200Response>>;
+    /**
+     * Fetch Markets
+     */
+    fetchMarkets(requestParameters: FetchMarketsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchMarkets200Response>;
+    /**
+     * Fetch OHLCV Candles
+     */
+    fetchOHLCVRaw(requestParameters: FetchOHLCVOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchOHLCV200Response>>;
+    /**
+     * Fetch OHLCV Candles
+     */
+    fetchOHLCV(requestParameters: FetchOHLCVOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchOHLCV200Response>;
+    /**
+     * Fetch Open Orders
+     */
+    fetchOpenOrdersRaw(requestParameters: FetchOpenOrdersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchOpenOrders200Response>>;
+    /**
+     * Fetch Open Orders
+     */
+    fetchOpenOrders(requestParameters: FetchOpenOrdersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchOpenOrders200Response>;
+    /**
+     * Fetch Order
+     */
+    fetchOrderRaw(requestParameters: FetchOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateOrder200Response>>;
+    /**
+     * Fetch Order
+     */
+    fetchOrder(requestParameters: FetchOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateOrder200Response>;
+    /**
+     * Fetch Order Book
+     */
+    fetchOrderBookRaw(requestParameters: FetchOrderBookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchOrderBook200Response>>;
+    /**
+     * Fetch Order Book
+     */
+    fetchOrderBook(requestParameters: FetchOrderBookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchOrderBook200Response>;
+    /**
+     * Fetch Positions
+     */
+    fetchPositionsRaw(requestParameters: FetchPositionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchPositions200Response>>;
+    /**
+     * Fetch Positions
+     */
+    fetchPositions(requestParameters: FetchPositionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchPositions200Response>;
+    /**
+     * Fetch Trades
+     */
+    fetchTradesRaw(requestParameters: FetchTradesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchTrades200Response>>;
+    /**
+     * Fetch Trades
+     */
+    fetchTrades(requestParameters: FetchTradesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchTrades200Response>;
+    /**
+     * Get Market by Slug
+     */
+    getMarketsBySlugRaw(requestParameters: GetMarketsBySlugOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchMarkets200Response>>;
+    /**
+     * Get Market by Slug
+     */
+    getMarketsBySlug(requestParameters: GetMarketsBySlugOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchMarkets200Response>;
+    /**
+     * Server Health Check
+     */
+    healthCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HealthCheck200Response>>;
+    /**
+     * Server Health Check
+     */
+    healthCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HealthCheck200Response>;
+    /**
+     * Search for markets by title or description.
+     * Search Markets
+     */
+    searchMarketsRaw(requestParameters: SearchMarketsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchMarkets200Response>>;
+    /**
+     * Search for markets by title or description.
+     * Search Markets
+     */
+    searchMarkets(requestParameters: SearchMarketsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchMarkets200Response>;
+}
+/**
+ * @export
+ */
+export declare const CancelOrderOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type CancelOrderOperationExchangeEnum = typeof CancelOrderOperationExchangeEnum[keyof typeof CancelOrderOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const CreateOrderOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type CreateOrderOperationExchangeEnum = typeof CreateOrderOperationExchangeEnum[keyof typeof CreateOrderOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchBalanceExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchBalanceExchangeEnum = typeof FetchBalanceExchangeEnum[keyof typeof FetchBalanceExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchMarketsOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchMarketsOperationExchangeEnum = typeof FetchMarketsOperationExchangeEnum[keyof typeof FetchMarketsOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchOHLCVOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchOHLCVOperationExchangeEnum = typeof FetchOHLCVOperationExchangeEnum[keyof typeof FetchOHLCVOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchOpenOrdersOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchOpenOrdersOperationExchangeEnum = typeof FetchOpenOrdersOperationExchangeEnum[keyof typeof FetchOpenOrdersOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchOrderExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchOrderExchangeEnum = typeof FetchOrderExchangeEnum[keyof typeof FetchOrderExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchOrderBookOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchOrderBookOperationExchangeEnum = typeof FetchOrderBookOperationExchangeEnum[keyof typeof FetchOrderBookOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchPositionsOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchPositionsOperationExchangeEnum = typeof FetchPositionsOperationExchangeEnum[keyof typeof FetchPositionsOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchTradesOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchTradesOperationExchangeEnum = typeof FetchTradesOperationExchangeEnum[keyof typeof FetchTradesOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const GetMarketsBySlugOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type GetMarketsBySlugOperationExchangeEnum = typeof GetMarketsBySlugOperationExchangeEnum[keyof typeof GetMarketsBySlugOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const SearchMarketsOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type SearchMarketsOperationExchangeEnum = typeof SearchMarketsOperationExchangeEnum[keyof typeof SearchMarketsOperationExchangeEnum];