@clear-street/clearstreet 0.93.1 → 0.95.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,18 @@ 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)
+   */
+  limit_offset?: string | null;
+
   /**
    * New limit price for the order
    */
@@ -337,6 +431,16 @@ export interface PrefillModifyOrderRequest {
    * New stop price for the order
    */
   stop_price?: string | null;
+
+  /**
+   * New trailing offset for trailing orders
+   */
+  trailing_offset?: string | null;
+
+  /**
+   * New trailing offset type (PRICE or BPS)
+   */
+  trailing_offset_type?: OrdersAPI.TrailingOffsetType | null;
 }
 
 /**
@@ -346,7 +450,96 @@ 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;
+
+  /**
+   * 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;
 }
 
 /**
@@ -467,6 +660,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;
@@ -493,9 +691,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

@@ -71,7 +71,11 @@ export class Orders extends APIResource {
   }
 
   /**
-   * Get Order By ID
+   * Fetch a single order. The `{order_id}` path parameter accepts either the order's
+   * `id` or its `client_order_id`. A `client_order_id` can only be used while the
+   * order is open; after that, use the `id` returned in every order response, or
+   * find the order with the list-orders endpoint's `order_ids` filter, which accepts
+   * both identifiers at any time.
    *
    * @example
    * ```ts
@@ -153,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.
  */
@@ -218,6 +204,22 @@ export interface Execution {
    * a null/undefined value is observed, it indicates it does not apply.
    */
   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_id?: string | null;
+
+  /**
+   * Venue where this fill occurred, as reported by that venue. Distinct from an
+   * order's `venue`, which is the routing destination. Codes are not normalized, so
+   * the format varies by venue. When a null/undefined value is observed, it
+   * indicates that there is no available data.
+   */
+  venue?: string | null;
 }
 
 export type ExecutionList = Array<Execution>;
@@ -550,6 +552,11 @@ export type QueueState = 'AWAITING_RELEASE' | 'RELEASED';
  * At least one field must be provided.
  */
 export interface ReplaceOrderRequest {
+  /**
+   * New limit offset for trailing stop-limit orders (signed)
+   */
+  limit_offset?: string | null;
+
   /**
    * New limit price for the order
    */
@@ -564,6 +571,16 @@ export interface ReplaceOrderRequest {
    * New stop price for the order
    */
   stop_price?: string | null;
+
+  /**
+   * New trailing offset for trailing orders
+   */
+  trailing_offset?: string | null;
+
+  /**
+   * New trailing offset type (PRICE or BPS)
+   */
+  trailing_offset_type?: TrailingOffsetType | null;
 }
 
 /**
@@ -587,10 +604,7 @@ export type RequestTimeInForce =
   | 'FILL_OR_KILL'
   | 'GOOD_TILL_DATE'
   | 'AT_THE_OPENING'
-  | 'AT_THE_CLOSE'
-  | 'GOOD_TILL_CROSSING'
-  | 'GOOD_THROUGH_CROSSING'
-  | 'AT_CROSSING';
+  | 'AT_THE_CLOSE';
 
 /**
  * Side of an order
@@ -608,9 +622,6 @@ export type TimeInForce =
   | 'GOOD_TILL_DATE'
   | 'AT_THE_OPENING'
   | 'AT_THE_CLOSE'
-  | 'GOOD_TILL_CROSSING'
-  | 'GOOD_THROUGH_CROSSING'
-  | 'AT_CROSSING'
   | 'OTHER';
 
 /**
@@ -710,6 +721,12 @@ export interface OrderGetExecutionsParams {
    */
   instrument_ids?: Array<string>;
 
+  /**
+   * Comma-separated order IDs to filter by. When provided, only executions belonging
+   * to an order in this set are returned.
+   */
+  order_ids?: Array<string>;
+
   /**
    * The number of items to return per page. Only used when page_token is not
    * provided.
@@ -726,6 +743,13 @@ export interface OrderGetExecutionsParams {
    * The end date and time for the query range, inclusive (ISO 8601 format)
    */
   to?: string;
+
+  /**
+   * Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option
+   * symbols). Matches option fills whose resolved underlier is any of the given
+   * instruments.
+   */
+  underlying_instrument_ids?: Array<string>;
 }
 
 export interface OrderGetOrderByIDParams {
@@ -753,8 +777,9 @@ export interface OrderGetOrdersParams {
   instrument_type?: 'COMMON_STOCK' | 'INDEX' | 'OPTION' | 'CASH';
 
   /**
-   * Comma-separated order IDs to filter by. When provided, only orders whose order
-   * ID is in this set are returned.
+   * Comma-separated list of order identifiers. Each value may be an order's `id` or
+   * its `client_order_id`; only orders matching one of the given identifiers are
+   * returned.
    */
   order_ids?: Array<string>;
 
@@ -815,6 +840,11 @@ export interface OrderReplaceOrderParams {
    */
   account_id: number;
 
+  /**
+   * Body param: New limit offset for trailing stop-limit orders (signed)
+   */
+  limit_offset?: string | null;
+
   /**
    * Body param: New limit price for the order
    */
@@ -829,6 +859,16 @@ export interface OrderReplaceOrderParams {
    * Body param: New stop price for the order
    */
   stop_price?: string | null;
+
+  /**
+   * Body param: New trailing offset for trailing orders
+   */
+  trailing_offset?: string | null;
+
+  /**
+   * Body param: New trailing offset type (PRICE or BPS)
+   */
+  trailing_offset_type?: TrailingOffsetType | null;
 }
 
 export interface OrderSubmitOrdersParams {
@@ -837,7 +877,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,

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