@clear-street/clearstreet 0.75.0 → 0.77.0

package/src/resources/v1/instrument-data/market-data.ts

@@ -69,32 +69,38 @@ export interface DailySummary {
   instrument_id: string;
 
   /**
-   * Session high.
+   * Session high. When a null/undefined value is observed, it indicates that there
+   * is no available data.
    */
   high?: string | null;
 
   /**
-   * Session low.
+   * Session low. When a null/undefined value is observed, it indicates that there is
+   * no available data.
    */
   low?: string | null;
 
   /**
-   * Opening price for the session.
+   * Opening price for the session. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   open?: string | null;
 
   /**
-   * Display symbol for the security. `None` for unresolvable IDs.
+   * Display symbol for the security. `None` for unresolvable IDs. When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   symbol?: string | null;
 
   /**
-   * Session date the OHLV represents, US/Eastern.
+   * Session date the OHLV represents, US/Eastern. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   trade_date?: string | null;
 
   /**
-   * Session cumulative trading volume.
+   * Session cumulative trading volume. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   volume?: number | null;
 }
@@ -117,33 +123,40 @@ export interface MarketDataSnapshot {
 
   /**
    * Cumulative traded volume reported on the most recent trade, in shares for
-   * equities or contracts for options. Absent when no trade is available.
+   * equities or contracts for options. Absent when no trade is available. When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   cumulative_volume?: number | null;
 
   /**
    * Theoretical price and Greeks for option instruments. `None` for equities, and
-   * for options whose Greeks have not yet been observed
+   * for options whose Greeks have not yet been observed When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   greeks?: SnapshotGreeks | null;
 
   /**
-   * Most recent quote if available.
+   * Most recent quote if available. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   last_quote?: SnapshotQuote | null;
 
   /**
-   * Most recent last-sale trade if available.
+   * Most recent last-sale trade if available. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   last_trade?: SnapshotLastTrade | null;
 
   /**
-   * Security name if available.
+   * Security name if available. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * Session metrics computed from previous close and last trade, if available.
+   * Session metrics computed from previous close and last trade, if available. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
    */
   session?: SnapshotSession | null;
 }
@@ -231,12 +244,14 @@ export interface SnapshotQuote {
   midpoint: string;
 
   /**
-   * Size at the best ask, in shares.
+   * Size at the best ask, in shares. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   ask_size?: number | null;
 
   /**
-   * Size at the best bid, in shares.
+   * Size at the best bid, in shares. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   bid_size?: number | null;
 }

package/src/resources/v1/instrument-data/news.ts

@@ -37,12 +37,14 @@ export interface NewsInstrument {
   instrument_id: string;
 
   /**
-   * Instrument name/description, if available.
+   * Instrument name/description, if available. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * Trading symbol, if available.
+   * Trading symbol, if available. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   symbol?: string | null;
 }
@@ -82,17 +84,20 @@ export interface NewsItem {
   url: string;
 
   /**
-   * URL of an associated image if provided by the source.
+   * URL of an associated image if provided by the source. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   image_url?: string | null;
 
   /**
-   * The primary domain/site of the publisher.
+   * The primary domain/site of the publisher. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   site?: string | null;
 
   /**
-   * The full or excerpted article body.
+   * The full or excerpted article body. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   text?: string | null;
 }

package/src/resources/v1/instruments.ts

@@ -173,53 +173,63 @@ export interface Instrument {
   venue: string;
 
   /**
-   * Average daily share volume from the security definition.
+   * Average daily share volume from the security definition. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   adv?: string | null;
 
   /**
-   * The expiration date for options instruments
+   * The expiration date for options instruments When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   expiry?: string | null;
 
   /**
-   * The type of security (e.g., Common Stock, ETF)
+   * The type of security (e.g., Common Stock, ETF) When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   instrument_type?: V1API.SecurityType | null;
 
   /**
-   * The percent of a long position's value you must post as margin
+   * The percent of a long position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   long_margin_rate?: string | null;
 
   /**
-   * The full name of the instrument or its issuer
+   * The full name of the instrument or its issuer When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * Notional average daily volume (ADV multiplied by previous close price).
+   * Notional average daily volume (ADV multiplied by previous close price). When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   notional_adv?: string | null;
 
   /**
    * Available options expiration dates for this instrument. Present only when
-   * `include_options_expiry_dates=true` in the request.
+   * `include_options_expiry_dates=true` in the request. When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   options_expiry_dates?: Array<string> | null;
 
   /**
-   * Last close price from the security definition.
+   * Last close price from the security definition. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   previous_close?: string | null;
 
   /**
-   * The percent of a short position's value you must post as margin
+   * The percent of a short position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   short_margin_rate?: string | null;
 
   /**
-   * The strike price for options instruments
+   * The strike price for options instruments When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   strike_price?: string | null;
 }
@@ -292,47 +302,56 @@ export interface InstrumentCore {
   venue: string;
 
   /**
-   * Average daily share volume from the security definition.
+   * Average daily share volume from the security definition. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   adv?: string | null;
 
   /**
-   * The expiration date for options instruments
+   * The expiration date for options instruments When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   expiry?: string | null;
 
   /**
-   * The type of security (e.g., Common Stock, ETF)
+   * The type of security (e.g., Common Stock, ETF) When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   instrument_type?: V1API.SecurityType | null;
 
   /**
-   * The percent of a long position's value you must post as margin
+   * The percent of a long position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   long_margin_rate?: string | null;
 
   /**
-   * The full name of the instrument or its issuer
+   * The full name of the instrument or its issuer When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * Notional average daily volume (ADV multiplied by previous close price).
+   * Notional average daily volume (ADV multiplied by previous close price). When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   notional_adv?: string | null;
 
   /**
-   * Last close price from the security definition.
+   * Last close price from the security definition. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   previous_close?: string | null;
 
   /**
-   * The percent of a short position's value you must post as margin
+   * The percent of a short position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   short_margin_rate?: string | null;
 
   /**
-   * The strike price for options instruments
+   * The strike price for options instruments When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   strike_price?: string | null;
 }
@@ -409,12 +428,14 @@ export interface OptionsContract {
   symbol: string;
 
   /**
-   * Open interest (number of outstanding contracts), if available
+   * Open interest (number of outstanding contracts), if available When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   open_interest?: number | null;
 
   /**
-   * Instrument ID of the underlying instrument, when available
+   * Instrument ID of the underlying instrument, when available When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   underlying_instrument_id?: string | null;
 }

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

@@ -63,6 +63,10 @@ export class Messages extends APIResource {
 export interface CreateFeedbackResponse {
   created_at: string;
 
+  /**
+   * When a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
   feedback_id?: string | null;
 }
 

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;
 }