@wahoopredict/trading-sdk 0.4.0 → 0.4.1

package/README.md

@@ -30,6 +30,28 @@ if (error) {
 }
 ```
 
+## Configuration
+
+### Custom Base URL
+
+```typescript
+const client = createWahooClient({
+  apiKey: "your-api-key",
+  secretKey: "your-secret-key",
+});
+```
+
+### Environment Variables
+
+We recommend storing credentials in environment variables:
+
+```typescript
+const client = createWahooClient({
+  apiKey: process.env.WAHOO_API_KEY!,
+  secretKey: process.env.WAHOO_SECRET_KEY!,
+});
+```
+
 ## Authentication
 
 The SDK uses HMAC-SHA256 signature-based authentication. You need an API key and secret key from WahooPredict.
@@ -266,44 +288,93 @@ Common error types:
 
 ## TypeScript Support
 
-The SDK provides full TypeScript support with auto-generated types from the OpenAPI specification:
+The SDK provides full TypeScript support with auto-generated types from the OpenAPI specification.
+
+### When You DON'T Need to Import Types
+
+For most usage, TypeScript inference handles everything:
 
 ```typescript
-import type { paths, components } from "@wahoopredict/trading-sdk";
+// Just works — no type imports needed
+const { data, error } = await client.POST("/event/positions", {
+  body: { page: 1, limit: 20 },
+});
+
+// TypeScript knows data.data is Position[]
+data?.data.forEach((position) => {
+  console.log(position.id, position.avgPrice); // Full autocomplete
+});
+```
+
+### When You NEED to Import Types
+
+Import types when you're writing functions that accept or return SDK data:
+
+```typescript
+import type { components } from "@wahoopredict/trading-sdk";
 
-// Use component types
-type Event = components["schemas"]["Event"];
-type Order = components["schemas"]["Order"];
 type Position = components["schemas"]["Position"];
+type Event = components["schemas"]["Event"];
 
-// Use path types for custom implementations
-type PlaceOrderBody =
-  paths["/event/place-order"]["post"]["requestBody"]["content"]["application/json"];
-```
+// Now you can use Position in your own function signatures
+function filterProfitablePositions(positions: Position[]): Position[] {
+  return positions.filter((p) => parseFloat(p.part) > 100);
+}
 
-## Configuration
+async function getEventWithPositions(client: WahooClient, eventId: string) {
+  const [event, positions] = await Promise.all([
+    client.GET("/event/event-details/{eventId}", {
+      params: { path: { eventId } },
+    }),
+    client.POST("/event/positions", { body: { page: 1, limit: 100 } }),
+  ]);
+
+  return {
+    event: event.data as Event | undefined,
+    positions: positions.data?.data as Position[] | undefined,
+  };
+}
+```
 
-### Custom Base URL
+### Common Type Extractions
 
 ```typescript
-const client = createWahooClient({
-  apiKey: "your-api-key",
-  secretKey: "your-secret-key",
-  baseUrl: "https://staging-api.wahoopredict.com/oapi/v2", // Optional
-});
+import type { components, operations } from "@wahoopredict/trading-sdk";
+
+// Entity types
+type Event = components["schemas"]["Event"];
+type Position = components["schemas"]["Position"];
+type Order = components["schemas"]["Order"];
+type Outcome = components["schemas"]["Outcome"];
+type OutcomeOption = components["schemas"]["OutcomeOption"];
+
+// Request body types (for building params programmatically)
+type PlaceOrderParams = components["schemas"]["placeOrderRequestBody"];
+type EventsListParams =
+  operations["getEventsList"]["requestBody"]["content"]["application/json"];
+
+// Response types (for annotating wrapper function returns)
+type EventsListResponse =
+  operations["getEventsList"]["responses"]["200"]["content"]["application/json"];
+type EventsListItem = EventsListResponse["data"][number];
 ```
 
-### Environment Variables
+### Using `paths` for Advanced Type Access
 
-We recommend storing credentials in environment variables:
+The `paths` type gives you access to request/response types for any endpoint:
 
 ```typescript
-const client = createWahooClient({
-  apiKey: process.env.WAHOO_API_KEY!,
-  secretKey: process.env.WAHOO_SECRET_KEY!,
-});
-```
+import type { paths } from "@wahoopredict/trading-sdk";
 
-## License
+// Extract request body type
+type PlaceOrderBody =
+  paths["/event/place-order"]["post"]["requestBody"]["content"]["application/json"];
 
-MIT
+// Extract successful response type
+type PlaceOrderResponse =
+  paths["/event/place-order"]["post"]["responses"]["200"]["content"]["application/json"];
+
+// Extract error response type
+type PlaceOrderError =
+  paths["/event/place-order"]["post"]["responses"]["400"]["content"]["application/json"];
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wahoopredict/trading-sdk",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "TypeScript SDK for the WahooPredict trading API",
   "author": "WahooPredict",
   "license": "MIT",