@clear-street/clearstreet 0.75.0 → 0.77.0

package/src/resources/v1/positions.ts

@@ -89,6 +89,12 @@ export class Positions extends APIResource {
    * Returns the current lifecycle state of the account's position instructions.
    * Optionally filter by a specific contract.
    *
+   * Note: instructions that fail pre-acceptance validation on `POST` — duplicates,
+   * `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` on a non-expiry day, insufficient
+   * position, or an unresolvable instrument — are rejected (with `status = REJECTED`
+   * and a `rejection_reason`) without being persisted, so they surface only in the
+   * `POST` response and never appear in this list.
+   *
    * @example
    * ```ts
    * const response =
@@ -127,14 +133,14 @@ export class Positions extends APIResource {
    *
    * - **All rows accepted** → `200 OK`. Every row is in `data` with `status = SENT`.
    * - **Partial success** → `207 Multi-Status`. `data` contains every row; rejected
-   *   rows carry `status = ENGINE_REJECTED` (or `REJECTED`) and `rejection_reason`.
-   *   The top-level `error` summarizes the batch failure.
+   *   rows carry `status = REJECTED` and `rejection_reason`. The top-level `error`
+   *   summarizes the batch failure.
    * - **All rows rejected** → `4xx`/`5xx`. The HTTP status reflects the aggregate
    *   cause: `409` when every row was a duplicate, `400` for validation failures
    *   like DNE/CEA on a non-expiry day, `503` if the clearing service is
-   *   unavailable. `data` still contains every row carrying
-   *   `status = ENGINE_REJECTED` and `rejection_reason` so callers can attribute
-   *   failures by `instruction_id`; the top-level `error` summarizes the batch.
+   *   unavailable. `data` still contains every row carrying `status = REJECTED` and
+   *   `rejection_reason` so callers can attribute failures by `instruction_id`; the
+   *   top-level `error` summarizes the batch.
    *
    * @example
    * ```ts
@@ -209,55 +215,66 @@ export interface Position {
   symbol: string;
 
   /**
-   * The average price paid per share or contract for this position
+   * The average price paid per share or contract for this position When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   avg_price?: string | null;
 
   /**
-   * The closing price used to value the position for the last trading day
+   * The closing price used to value the position for the last trading day When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   closing_price?: string | null;
 
   /**
-   * The market date associated with `closing_price`
+   * The market date associated with `closing_price` When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   closing_price_date?: string | null;
 
   /**
-   * The total cost basis for this position
+   * The total cost basis for this position When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   cost_basis?: string | null;
 
   /**
    * The unrealized profit or loss for this position relative to the previous close
+   * When a null/undefined value is observed, it indicates that there is no available
+   * data.
    */
   daily_unrealized_pnl?: string | null;
 
   /**
    * The unrealized profit/loss for the position for the current day, expressed as a
-   * percentage of the baseline value (range: 0-100).
+   * percentage of the baseline value (range: 0-100). When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   daily_unrealized_pnl_pct?: string | null;
 
   /**
-   * The current market price of the instrument
+   * The current market price of the instrument When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   instrument_price?: string | null;
 
   /**
-   * Identifier of the underlying instrument, when available
+   * Identifier of the underlying instrument, when available When a null/undefined
+   * value is observed, it indicates it does not apply.
    */
   underlying_instrument_id?: string | null;
 
   /**
    * The total unrealized profit or loss for this position based on current market
-   * value
+   * value When a null/undefined value is observed, it indicates that there is no
+   * available data.
    */
   unrealized_pnl?: string | null;
 
   /**
    * The unrealized profit/loss for the position, expressed as a percentage of the
-   * position's cost basis (range: 0-100).
+   * position's cost basis (range: 0-100). When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   unrealized_pnl_pct?: string | null;
 }
@@ -309,25 +326,28 @@ export interface PositionInstruction {
 
   /**
    * Number of contracts accepted by the clearing venue. Populated once the
-   * instruction reaches `ACCEPTED`.
+   * instruction reaches `ACCEPTED`. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   accepted_quantity?: string | null;
 
   /**
-   * When the instruction was first accepted by the service.
+   * When the instruction was first accepted by the service. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   created_at?: string | null;
 
   /**
    * Human-readable explanation populated on any non-success terminal status —
-   * `REJECTED`, `ENGINE_REJECTED`, or `CANCEL_FAILED`. On a `207 Multi-Status` batch
-   * submit the top-level `error` field summarizes the batch; per-row detail
-   * continues to live here.
+   * `REJECTED` or `CANCEL_FAILED`. On a `207 Multi-Status` batch submit the
+   * top-level `error` field summarizes the batch; per-row detail continues to live
+   * here. When a null/undefined value is observed, it indicates it does not apply.
    */
   rejection_reason?: string | null;
 
   /**
-   * When the instruction's lifecycle state last changed.
+   * When the instruction's lifecycle state last changed. When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   updated_at?: string | null;
 }
@@ -339,12 +359,11 @@ export type PositionInstructionList = Array<PositionInstruction>;
  *
  * - `SENT`: accepted and submitted to the clearing venue.
  * - `ACCEPTED`: terminal — accepted by the clearing venue.
- * - `REJECTED`: terminal rejection from the clearing venue; `rejection_reason`
- *   carries the venue-reported detail.
- * - `ENGINE_REJECTED`: terminal rejection from validation; `rejection_reason`
- *   carries the detail. Typical causes: duplicate `instruction_id`,
- *   `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` submitted on a non-expiry day,
- *   insufficient position, or an invalid instrument.
+ * - `REJECTED`: terminal rejection; `rejection_reason` carries the detail. Covers
+ *   both venue-reported rejections and rejections raised before the instruction
+ *   reached the clearing venue (e.g. duplicate `instruction_id`, `DO_NOT_EXERCISE`
+ *   / `CONTRARY_EXERCISE` submitted on a non-expiry day, insufficient position, or
+ *   an instrument that does not resolve).
  * - `CANCEL_REQUESTED`: cancel accepted; final cancel state pending.
  * - `CANCELLED`: terminal — cancel completed.
  * - `CANCEL_FAILED`: cancel could not be completed; operator attention required.
@@ -355,7 +374,6 @@ export type PositionInstructionStatus =
   | 'SENT'
   | 'ACCEPTED'
   | 'REJECTED'
-  | 'ENGINE_REJECTED'
   | 'CANCEL_REQUESTED'
   | 'CANCELLED'
   | 'CANCEL_FAILED'

package/src/resources/v1/v1.ts

@@ -144,8 +144,6 @@ import {
   WatchlistGetWatchlistsResponse,
   WatchlistItemEntry,
 } from './watchlist';
-import * as WebsocketAPI from './websocket';
-import { Websocket } from './websocket';
 import * as InstrumentDataAPI from './instrument-data/instrument-data';
 import {
   AllEventsEventType,
@@ -223,7 +221,6 @@ export class V1 extends APIResource {
   orders: OrdersAPI.Orders = new OrdersAPI.Orders(this._client);
   positions: PositionsAPI.Positions = new PositionsAPI.Positions(this._client);
   watchlist: WatchlistAPI.Watchlist = new WatchlistAPI.Watchlist(this._client);
-  websocket: WebsocketAPI.Websocket = new WebsocketAPI.Websocket(this._client);
 }
 
 /**
@@ -240,7 +237,6 @@ V1.OmniAI = OmniAI;
 V1.Orders = Orders;
 V1.Positions = Positions;
 V1.Watchlist = Watchlist;
-V1.Websocket = Websocket;
 
 export declare namespace V1 {
   export { type SecurityType as SecurityType };
@@ -457,6 +453,4 @@ export declare namespace V1 {
     type WatchlistDeleteWatchlistItemParams as WatchlistDeleteWatchlistItemParams,
     type WatchlistGetWatchlistsParams as WatchlistGetWatchlistsParams,
   };
-
-  export { Websocket as Websocket };
 }

package/src/resources/v1/watchlist.ts

@@ -193,12 +193,14 @@ export interface WatchlistItemEntry {
   added_at: string;
 
   /**
-   * Price when the item was added
+   * Price when the item was added When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   added_price?: string | null;
 
   /**
-   * Instrument details
+   * Instrument details When a null/undefined value is observed, it indicates that
+   * there is no available data.
    */
   instrument?: InstrumentsAPI.Instrument | null;
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.75.0'; // x-release-please-version
+export const VERSION = '0.77.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.75.0";
+export declare const VERSION = "0.77.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.75.0";
+export declare const VERSION = "0.77.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.75.0'; // x-release-please-version
+exports.VERSION = '0.77.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.75.0'; // x-release-please-version
+export const VERSION = '0.77.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/resources/v1/websocket.d.mts

@@ -1,18 +0,0 @@
-import { APIResource } from "../../core/resource.mjs";
-import { APIPromise } from "../../core/api-promise.mjs";
-import { RequestOptions } from "../../internal/request-options.mjs";
-/**
- * Active Websocket.
- */
-export declare class Websocket extends APIResource {
-    /**
-     * Upgrade the HTTP connection to a WebSocket and echo incoming messages.
-     *
-     * @example
-     * ```ts
-     * await client.v1.websocket.websocketHandler();
-     * ```
-     */
-    websocketHandler(options?: RequestOptions): APIPromise<void>;
-}
-//# sourceMappingURL=websocket.d.mts.map

package/resources/v1/websocket.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"websocket.d.mts","sourceRoot":"","sources":["../../src/resources/v1/websocket.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM7D"}

package/resources/v1/websocket.d.ts

@@ -1,18 +0,0 @@
-import { APIResource } from "../../core/resource.js";
-import { APIPromise } from "../../core/api-promise.js";
-import { RequestOptions } from "../../internal/request-options.js";
-/**
- * Active Websocket.
- */
-export declare class Websocket extends APIResource {
-    /**
-     * Upgrade the HTTP connection to a WebSocket and echo incoming messages.
-     *
-     * @example
-     * ```ts
-     * await client.v1.websocket.websocketHandler();
-     * ```
-     */
-    websocketHandler(options?: RequestOptions): APIPromise<void>;
-}
-//# sourceMappingURL=websocket.d.ts.map

package/resources/v1/websocket.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"websocket.d.ts","sourceRoot":"","sources":["../../src/resources/v1/websocket.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM7D"}

package/resources/v1/websocket.js

@@ -1,27 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Websocket = void 0;
-const resource_1 = require("../../core/resource.js");
-const headers_1 = require("../../internal/headers.js");
-/**
- * Active Websocket.
- */
-class Websocket extends resource_1.APIResource {
-    /**
-     * Upgrade the HTTP connection to a WebSocket and echo incoming messages.
-     *
-     * @example
-     * ```ts
-     * await client.v1.websocket.websocketHandler();
-     * ```
-     */
-    websocketHandler(options) {
-        return this._client.get('/v1/ws', {
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
-        });
-    }
-}
-exports.Websocket = Websocket;
-//# sourceMappingURL=websocket.js.map

package/resources/v1/websocket.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"websocket.js","sourceRoot":"","sources":["../../src/resources/v1/websocket.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAGtD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE;YAChC,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAfD,8BAeC"}

package/resources/v1/websocket.mjs

@@ -1,23 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../core/resource.mjs";
-import { buildHeaders } from "../../internal/headers.mjs";
-/**
- * Active Websocket.
- */
-export class Websocket extends APIResource {
-    /**
-     * Upgrade the HTTP connection to a WebSocket and echo incoming messages.
-     *
-     * @example
-     * ```ts
-     * await client.v1.websocket.websocketHandler();
-     * ```
-     */
-    websocketHandler(options) {
-        return this._client.get('/v1/ws', {
-            ...options,
-            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-        });
-    }
-}
-//# sourceMappingURL=websocket.mjs.map

package/resources/v1/websocket.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"websocket.mjs","sourceRoot":"","sources":["../../src/resources/v1/websocket.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAGtD;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE;YAChC,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/resources/v1/websocket.ts

@@ -1,26 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../core/resource';
-import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-
-/**
- * Active Websocket.
- */
-export class Websocket extends APIResource {
-  /**
-   * Upgrade the HTTP connection to a WebSocket and echo incoming messages.
-   *
-   * @example
-   * ```ts
-   * await client.v1.websocket.websocketHandler();
-   * ```
-   */
-  websocketHandler(options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/v1/ws', {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-}