@clear-street/clearstreet 0.94.0 → 0.96.0

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

@@ -90,6 +90,13 @@ export interface ActionButton {
    */
   label: string;
 
+  /**
+   * Interaction-tracking identity. Absent on messages created before tracking. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
+  itemId?: string | null;
+
   /**
    * Follow-up prompt to submit as the next user message. When a null/undefined value
    * is observed, it indicates it does not apply.
@@ -112,6 +119,11 @@ export interface ChartPayload {
    */
   chartId: string;
 
+  /**
+   * Whether the current user clicked this chart.
+   */
+  clicked: boolean;
+
   /**
    * Buttons associated with this chart.
    */
@@ -122,6 +134,13 @@ export interface ChartPayload {
    * observed, it indicates it does not apply.
    */
   dataChart?: DataChart | null;
+
+  /**
+   * Interaction-tracking identity. Absent on messages created before tracking. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
+  itemId?: string | null;
 }
 
 /**
@@ -172,6 +191,23 @@ export interface ContentPartStructuredActionPayload {
   action: StructuredAction;
 
   action_id: string;
+
+  /**
+   * Whether the current user clicked this action.
+   */
+  clicked: boolean;
+
+  /**
+   * IDs of nested items clicked by the current user.
+   */
+  clicked_item_ids?: Array<string>;
+
+  /**
+   * Interaction-tracking identity. Absent on messages created before tracking. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
+  item_id?: string | null;
 }
 
 /**
@@ -230,6 +266,13 @@ export interface OpenChartAction {
    */
   extras?: unknown;
 
+  /**
+   * Interaction-tracking identity. Absent on messages created before tracking. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
+  item_id?: string | null;
+
   /**
    * Chart timeframe (e.g., "1D", "1W", "1M", "3M", "1Y", "5Y") When a null/undefined
    * value is observed, it indicates it does not apply.
@@ -251,6 +294,13 @@ export interface OpenEntitlementConsentAction {
   entitlement_codes: Array<EntitlementCode>;
 
   reason: string;
+
+  /**
+   * Interaction-tracking identity. Absent on messages created before tracking. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
+  item_id?: string | null;
 }
 
 /**
@@ -268,6 +318,13 @@ export interface OpenScreenerAction {
    */
   columns?: Array<string> | null;
 
+  /**
+   * Interaction-tracking identity. Absent on messages created before tracking. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
+  item_id?: string | null;
+
   /**
    * Optional page size. When a null/undefined value is observed, it indicates it
    * does not apply.
@@ -294,7 +351,32 @@ export interface PrefillCancelOrderAction {
   /**
    * Orders to cancel using the same identifiers required by the cancel-order API.
    */
-  orders: Array<OrdersAPI.CancelOrderRequest>;
+  orders: Array<PrefillCancelOrderRequest>;
+}
+
+/**
+ * Request to cancel an existing order
+ *
+ * Note: In the API, order cancellation is done via DELETE request without a body.
+ * The order_id and account_id come from the URL path parameters.
+ */
+export interface PrefillCancelOrderRequest {
+  /**
+   * Account ID (from path parameter)
+   */
+  account_id: number;
+
+  /**
+   * Order ID to cancel (from path parameter)
+   */
+  order_id: string;
+
+  /**
+   * Interaction-tracking identity. Absent on messages created before tracking. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
+  item_id?: string | null;
 }
 
 /**
@@ -318,6 +400,13 @@ export interface PrefillModifyOrderRequest {
    */
   account_id?: number;
 
+  /**
+   * Interaction-tracking identity. Absent on messages created before tracking. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
+  item_id?: string | null;
+
   /**
    * New limit offset for trailing stop-limit orders (signed)
    */
@@ -361,7 +450,102 @@ export interface PrefillNewOrderAction {
   /**
    * Orders to prefill using the same shape accepted by the orders API.
    */
-  orders: Array<OrdersAPI.NewOrderRequest>;
+  orders: Array<PrefillNewOrderRequest>;
+}
+
+/**
+ * Request to submit a new order (PlaceOrderRequest from spec)
+ */
+export interface PrefillNewOrderRequest {
+  /**
+   * Type of order
+   */
+  order_type: OrdersAPI.RequestOrderType;
+
+  /**
+   * Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported).
+   * For OPTION (single-leg): contracts (must be an integer)
+   */
+  quantity: string;
+
+  /**
+   * Side of the order
+   */
+  side: OrdersAPI.Side;
+
+  /**
+   * Time in force
+   */
+  time_in_force: OrdersAPI.RequestTimeInForce;
+
+  /**
+   * Optional client-provided unique ID (idempotency). Required to be unique per
+   * account.
+   */
+  id?: string | null;
+
+  /**
+   * The timestamp when the order should expire (UTC). Required when time_in_force is
+   * GOOD_TILL_DATE.
+   */
+  expires_at?: string | null;
+
+  /**
+   * Allow trading outside regular trading hours. Some brokers disallow options
+   * outside RTH.
+   */
+  extended_hours?: boolean | null;
+
+  /**
+   * Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either
+   * `symbol` or `instrument_id` must be provided.
+   */
+  instrument_id?: OrdersAPI.InstrumentIDOrSymbol | null;
+
+  /**
+   * Interaction-tracking identity. Absent on messages created before tracking. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
+  item_id?: string | null;
+
+  /**
+   * Limit offset for trailing stop-limit orders (signed)
+   */
+  limit_offset?: string | null;
+
+  /**
+   * Limit price (required for LIMIT and STOP_LIMIT orders)
+   */
+  limit_price?: string | null;
+
+  /**
+   * Optional open/close intent for this order. When omitted, the platform determines
+   * the position effect.
+   */
+  position_intent?: OrdersAPI.RequestPositionEffect | null;
+
+  /**
+   * Stop price (required for STOP and STOP_LIMIT orders)
+   */
+  stop_price?: string | null;
+
+  /**
+   * Trading symbol. For equities, use the ticker symbol (e.g., "TSLA"). For options,
+   * use the OSI symbol (e.g., "TSLA 250117C00190000"). Either `symbol` or
+   * `instrument_id` must be provided.
+   */
+  symbol?: string | null;
+
+  /**
+   * Trailing offset amount (required for trailing orders)
+   */
+  trailing_offset?: string | null;
+
+  /**
+   * Trailing offset type (PRICE or PERCENT_BPS)
+   */
+  trailing_offset_type?: OrdersAPI.TrailingOffsetType | null;
 }
 
 /**
@@ -482,6 +666,11 @@ export interface SuggestedActionsPayload {
    * Ordered message-level buttons.
    */
   actionButtons?: Array<ActionButton>;
+
+  /**
+   * IDs of buttons clicked by the current user.
+   */
+  clickedItemIds?: Array<string>;
 }
 
 OmniAI.Entitlements = Entitlements;
@@ -508,9 +697,11 @@ export declare namespace OmniAI {
     type OpenEntitlementConsentAction as OpenEntitlementConsentAction,
     type OpenScreenerAction as OpenScreenerAction,
     type PrefillCancelOrderAction as PrefillCancelOrderAction,
+    type PrefillCancelOrderRequest as PrefillCancelOrderRequest,
     type PrefillModifyOrderAction as PrefillModifyOrderAction,
     type PrefillModifyOrderRequest as PrefillModifyOrderRequest,
     type PrefillNewOrderAction as PrefillNewOrderAction,
+    type PrefillNewOrderRequest as PrefillNewOrderRequest,
     type PrefillOrderAction as PrefillOrderAction,
     type PromptButtonAction as PromptButtonAction,
     type StructuredAction as StructuredAction,

package/src/resources/v1/orders.ts

@@ -157,24 +157,6 @@ export class Orders extends APIResource {
   }
 }
 
-/**
- * Request to cancel an existing order
- *
- * Note: In the API, order cancellation is done via DELETE request without a body.
- * The order_id and account_id come from the URL path parameters.
- */
-export interface CancelOrderRequest {
-  /**
-   * Account ID (from path parameter)
-   */
-  account_id: number;
-
-  /**
-   * Order ID to cancel (from path parameter)
-   */
-  order_id: string;
-}
-
 /**
  * Represents a single fill of an order for an account.
  */
@@ -224,10 +206,10 @@ export interface Execution {
   symbol?: string | null;
 
   /**
-   * Underlying instrument identifier for a derivative fill. `null` for a
-   * non-derivative fill, when the underlier could not be resolved, or when a
-   * multileg fill's legs resolve to different underliers. When a null/undefined
-   * value is observed, it indicates it does not apply.
+   * Underlying instrument identifier for an option fill. Omitted for a
+   * non-derivative fill, when the underlier could not be resolved, or for a multileg
+   * fill (per-leg underliers live in `legs[]`). When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   underlying_instrument_id?: string | null;
 
@@ -307,6 +289,12 @@ export interface NewOrderRequest {
    */
   limit_price?: string | null;
 
+  /**
+   * Optional open/close intent for this order. When omitted, the platform determines
+   * the position effect.
+   */
+  position_intent?: RequestPositionEffect | null;
+
   /**
    * Stop price (required for STOP and STOP_LIMIT orders)
    */
@@ -379,7 +367,7 @@ export interface Order {
   quantity: string;
 
   /**
-   * Side of the order (BUY, SELL, SELL_SHORT)
+   * Side of the order (BUY or SELL)
    */
   side: Side;
 
@@ -612,6 +600,12 @@ export type RequestOrderType =
   | 'TRAILING_STOP'
   | 'TRAILING_STOP_LIMIT';
 
+/**
+ * Position effect for a multileg strategy leg: client-attested open/close intent.
+ * Required on every leg of a multileg order submission.
+ */
+export type RequestPositionEffect = 'OPEN' | 'CLOSE';
+
 /**
  * Strict time-in-force enum for order submission requests.
  */
@@ -625,9 +619,9 @@ export type RequestTimeInForce =
   | 'AT_THE_CLOSE';
 
 /**
- * Side of an order
+ * Side of the order (BUY or SELL).
  */
-export type Side = 'BUY' | 'SELL' | 'SELL_SHORT' | 'OTHER';
+export type Side = 'BUY' | 'SELL';
 
 /**
  * Time in force
@@ -711,7 +705,7 @@ export interface OrderCancelAllOpenOrdersParams {
   /**
    * Filter by order side (BUY or SELL)
    */
-  side?: 'BUY' | 'SELL' | 'SELL_SHORT' | 'OTHER';
+  side?: 'BUY' | 'SELL';
 
   /**
    * Filter by order type (e.g., MARKET, LIMIT)
@@ -895,7 +889,6 @@ export interface OrderSubmitOrdersParams {
 
 export declare namespace Orders {
   export {
-    type CancelOrderRequest as CancelOrderRequest,
     type Execution as Execution,
     type ExecutionList as ExecutionList,
     type InstrumentIDOrSymbol as InstrumentIDOrSymbol,
@@ -907,6 +900,7 @@ export declare namespace Orders {
     type QueueState as QueueState,
     type ReplaceOrderRequest as ReplaceOrderRequest,
     type RequestOrderType as RequestOrderType,
+    type RequestPositionEffect as RequestPositionEffect,
     type RequestTimeInForce as RequestTimeInForce,
     type Side as Side,
     type TimeInForce as TimeInForce,

package/src/resources/v1/positions.ts

@@ -139,8 +139,8 @@ export class Positions extends APIResource {
    *   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 = REJECTED` and
-   *   `rejection_reason` so callers can attribute failures by `instruction_id`; the
-   *   top-level `error` summarizes the batch.
+   *   `rejection_reason` so callers can attribute failures by
+   *   `client_instruction_id`; the top-level `error` summarizes the batch.
    *
    * @example
    * ```ts
@@ -303,7 +303,7 @@ export interface PositionInstruction {
    * Caller-supplied idempotency key echoed from the submit request; the
    * server-assigned fallback when none was supplied.
    */
-  instruction_id: string;
+  client_instruction_id: string;
 
   /**
    * The action this instruction requests.
@@ -351,6 +351,12 @@ export interface PositionInstruction {
    */
   rejection_reason?: string | null;
 
+  /**
+   * 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;
+
   /**
    * When the instruction's lifecycle state last changed. When a null/undefined value
    * is observed, it indicates that there is no available data.
@@ -367,9 +373,9 @@ export type PositionInstructionList = Array<PositionInstruction>;
  * - `ACCEPTED`: terminal — accepted by the clearing venue.
  * - `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).
+ *   reached the clearing venue (e.g. duplicate `client_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.
@@ -458,6 +464,13 @@ export interface PositionGetPositionInstructionsParams {
    * ticker or OSI option symbol).
    */
   instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
+
+  /**
+   * Limit results to instructions whose contract has this underlier. Instrument ID
+   * (UUID) or symbol (equity ticker or OSI option symbol). Combined with
+   * `instrument_id` as a logical AND when both are supplied.
+   */
+  underlying_instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
 }
 
 export interface PositionGetPositionsParams {
@@ -528,7 +541,7 @@ export namespace PositionSubmitPositionInstructionsParams {
      * Caller-supplied idempotency key. Echoed on the response. The server generates a
      * unique id when omitted.
      */
-    instruction_id?: string | null;
+    client_instruction_id?: string | null;
   }
 }
 

package/src/resources/v1/private-markets/index.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Offerings,
+  type Currency,
+  type MetricUnit,
+  type MetricValueType,
+  type OfferingCard,
+  type OfferingCardList,
+  type OfferingClass,
+  type OfferingCompany,
+  type OfferingDetail,
+  type OfferingDocumentResource,
+  type OfferingDocumentType,
+  type OfferingHighlight,
+  type OfferingKeyRisk,
+  type OfferingParticipantResource,
+  type OfferingSpv,
+  type ParticipantRole,
+  type SpvStatus,
+  type ValuationBasis,
+  type OfferingGetOfferingByIDResponse,
+  type OfferingGetOfferingsResponse,
+  type OfferingGetOfferingByIDParams,
+  type OfferingGetOfferingsParams,
+} from './offerings';
+export { PrivateMarkets } from './private-markets';