@clear-street/clearstreet 0.76.0 → 0.77.0

package/src/resources/v1/omni-ai/omni-ai.ts

@@ -90,12 +90,14 @@ export interface ActionButton {
   label: string;
 
   /**
-   * Follow-up prompt to submit as the next user message.
+   * Follow-up prompt to submit as the next user message. When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   prompt?: PromptButtonAction | null;
 
   /**
-   * Structured action in the same message to execute on click.
+   * Structured action in the same message to execute on click. When a null/undefined
+   * value is observed, it indicates it does not apply.
    */
   structuredAction?: StructuredActionButtonAction | null;
 }
@@ -115,7 +117,8 @@ export interface ChartPayload {
   actionButtons?: Array<ActionButton>;
 
   /**
-   * Explicit series-driven chart definition.
+   * Explicit series-driven chart definition. When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   dataChart?: DataChart | null;
 }
@@ -221,12 +224,14 @@ export interface OpenChartAction {
   symbol: string;
 
   /**
-   * Additional chart configuration (indicators, overlays, etc.)
+   * Additional chart configuration (indicators, overlays, etc.) When a
+   * null/undefined value is observed, it indicates it does not apply.
    */
   extras?: unknown;
 
   /**
-   * Chart timeframe (e.g., "1D", "1W", "1M", "3M", "1Y", "5Y")
+   * Chart timeframe (e.g., "1D", "1W", "1M", "3M", "1Y", "5Y") When a null/undefined
+   * value is observed, it indicates it does not apply.
    */
   timeframe?: string | null;
 }
@@ -257,22 +262,26 @@ export interface OpenScreenerAction {
   filters: Array<ScreenerFilter>;
 
   /**
-   * Optional field/column selection for screener results.
+   * Optional field/column selection for screener results. When a null/undefined
+   * value is observed, it indicates it does not apply.
    */
   field_filter?: Array<string> | null;
 
   /**
-   * Optional page size.
+   * Optional page size. When a null/undefined value is observed, it indicates it
+   * does not apply.
    */
   page_size?: number | null;
 
   /**
-   * Optional sort field for screener rows.
+   * Optional sort field for screener rows. When a null/undefined value is observed,
+   * it indicates it does not apply.
    */
   sort_by?: string | null;
 
   /**
-   * Optional sort direction (`ASC` or `DESC`).
+   * Optional sort direction (`ASC` or `DESC`). When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   sort_direction?: string | null;
 }
@@ -413,7 +422,8 @@ export namespace StructuredAction {
  */
 export interface StructuredActionButtonAction {
   /**
-   * UUID of a `structured_action` content part in the same message.
+   * UUID of a `structured_action` content part in the same message. When a
+   * null/undefined value is observed, it indicates it does not apply.
    */
   actionId?: string | null;
 }

package/src/resources/v1/omni-ai/responses.ts

@@ -81,6 +81,9 @@ export interface ErrorStatus {
 
   message: string;
 
+  /**
+   * When a null/undefined value is observed, it indicates it does not apply.
+   */
   details?: unknown | null;
 }
 
@@ -100,15 +103,19 @@ export interface Response {
   user_message_id: string;
 
   /**
-   * Dynamic response content container. May include thinking parts.
+   * When a null/undefined value is observed, it indicates that there is no available
+   * data.
    */
   content?: ResponseContent | null;
 
   /**
-   * Shared sanitized error payload.
+   * When a null/undefined value is observed, it indicates it does not apply.
    */
   error?: ErrorStatus | null;
 
+  /**
+   * When a null/undefined value is observed, it indicates it does not apply.
+   */
   output_message_id?: string | null;
 }
 

package/src/resources/v1/omni-ai/threads.ts

@@ -216,7 +216,7 @@ export interface Message {
   thread_id: string;
 
   /**
-   * Shared sanitized error payload.
+   * When a null/undefined value is observed, it indicates it does not apply.
    */
   error?: ResponsesAPI.ErrorStatus | null;
 }

package/src/resources/v1/orders.ts

@@ -414,7 +414,8 @@ export interface Order {
   venue: string;
 
   /**
-   * Average fill price across all executions
+   * Average fill price across all executions When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   average_fill_price?: string | null;
 
@@ -425,7 +426,8 @@ export interface Order {
 
   /**
    * Timestamp when the order will expire (UTC). Present when time_in_force is
-   * GOOD_TILL_DATE.
+   * GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does
+   * not apply.
    */
   expires_at?: string | null;
 
@@ -435,65 +437,78 @@ export interface Order {
   extended_hours?: boolean | null;
 
   /**
-   * Limit offset for trailing stop-limit orders (signed)
+   * Limit offset for trailing stop-limit orders (signed) When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   limit_offset?: string | null;
 
   /**
-   * Limit price (for LIMIT and STOP_LIMIT orders)
+   * Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   limit_price?: string | null;
 
   /**
    * Parent order queue state, present when the order is awaiting release or
-   * released.
+   * released. When a null/undefined value is observed, it indicates it does not
+   * apply.
    */
   queue_state?: QueueState | null;
 
   /**
-   * Scheduled release time for orders awaiting release.
+   * Scheduled release time for orders awaiting release. When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   releases_at?: string | null;
 
   /**
-   * Stop price (for STOP and STOP_LIMIT orders)
+   * Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   stop_price?: string | null;
 
   /**
-   * Current trailing limit price computed by the trailing strategy
+   * Current trailing limit price computed by the trailing strategy When a
+   * null/undefined value is observed, it indicates it does not apply.
    */
   trailing_limit_px?: string | null;
 
   /**
-   * Trailing offset amount for trailing orders
+   * Trailing offset amount for trailing orders When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   trailing_offset?: string | null;
 
   /**
-   * Trailing offset type for trailing orders
+   * Trailing offset type for trailing orders When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   trailing_offset_type?: TrailingOffsetType | null;
 
   /**
-   * Current trailing stop price computed by the trailing strategy
+   * Current trailing stop price computed by the trailing strategy When a
+   * null/undefined value is observed, it indicates it does not apply.
    */
   trailing_stop_px?: string | null;
 
   /**
-   * Trailing watermark price for trailing orders
+   * Trailing watermark price for trailing orders When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   trailing_watermark_px?: string | null;
 
   /**
-   * Trailing watermark timestamp for trailing orders
+   * Trailing watermark timestamp for trailing orders When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   trailing_watermark_ts?: string | null;
 
   /**
    * Instrument ID of the option's underlying instrument. Populated only for options
-   * orders; `null` for non-options and for options whose underlier cannot be
-   * resolved.
+   * orders. A `null` means one of two things: the order is not an option, so the
+   * field does not apply; or the order is an option whose underlier has not yet been
+   * resolved. When a null/undefined value is observed, it indicates it does not
+   * apply.
    */
   underlying_instrument_id?: string | null;
 }

package/src/resources/v1/positions.ts

@@ -215,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;
 }
@@ -315,12 +326,14 @@ 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;
 
@@ -328,12 +341,13 @@ export interface PositionInstruction {
    * Human-readable explanation populated on any non-success terminal status —
    * `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.
+   * 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;
 }

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.76.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.76.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.76.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.76.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.76.0'; // x-release-please-version
+export const VERSION = '0.77.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map