@clear-street/clearstreet 0.97.0 → 0.99.0

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

@@ -0,0 +1,218 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Personalized feed of market stories: upcoming earnings, dividends, and splits, plus market news. Served per caller in a stable order; item ids double as pagination cursors, so any previously returned page can be re-read.
+ */
+export class OmniFeed extends APIResource {
+  /**
+   * > **Alpha** — this endpoint is experimental and may change or be removed at any
+   * > time.
+   *
+   * Returns the caller's personalized feed of market stories: upcoming earnings,
+   * dividends, and splits, plus market news.
+   *
+   * The feed is a stable, append-only sequence per caller. Without a `cursor`, the
+   * response resumes from the caller's oldest unseen item and continues forward;
+   * passing the id of the last item received as `cursor` returns the items after it.
+   * Either way, when the known sequence runs short of `limit`, fresh stories are
+   * appended and included. Re-requesting an earlier cursor replays the same items in
+   * the same order.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.omniFeed.getFeed();
+   * ```
+   */
+  getFeed(
+    query: OmniFeedGetFeedParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<OmniFeedGetFeedResponse> {
+    return this._client.get('/v1/omni-ai/feed', { query, ...options });
+  }
+
+  /**
+   * > **Alpha** — this endpoint is experimental and may change or be removed at any
+   * > time.
+   *
+   * Records one of the caller's interactions with a feed item: the item rendered on
+   * screen (`seen`), expanded from its headline to its summary (`click`), or voted
+   * on (`upvote`, `downvote`). Marking an item `seen` excludes it from the caller's
+   * next feed response.
+   *
+   * Each request records a new event, so a request that is retried after a failure
+   * of unknown outcome may be recorded twice. That is harmless for `seen` and for
+   * votes — the first is a yes-or-no exclusion and the latest vote is the one that
+   * counts — so retry freely for those. The event is wrapped in an `event` field so
+   * that a future request may carry several at once without breaking this one.
+   *
+   * @example
+   * ```ts
+   * await client.v1.omniFeed.postFeedEvent({
+   *   event: {
+   *     item_id: '0198f3a2-4b3d-7c1e-9f2a-3b4c5d6e7f80',
+   *     type: 'seen',
+   *   },
+   * });
+   * ```
+   */
+  postFeedEvent(body: OmniFeedPostFeedEventParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/v1/omni-ai/feed/events', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+/**
+ * One item in the caller's feed.
+ */
+export interface FeedItem {
+  /**
+   * Unique item id. Also the pagination cursor: pass it as `cursor` to fetch the
+   * items that follow it.
+   */
+  id: string;
+
+  /**
+   * Headline text.
+   */
+  headline: string;
+
+  /**
+   * What the item is about.
+   */
+  kind: FeedItemKind;
+
+  /**
+   * When the item's content was published.
+   */
+  published_at: string;
+
+  /**
+   * Summary text.
+   */
+  summary: string;
+
+  /**
+   * The item's headline number. When a null/undefined value is observed, it
+   * indicates that there is no available data.
+   */
+  metric?: FeedItemMetric | null;
+
+  /**
+   * When the underlying event is expected to occur, for items about an upcoming
+   * event. When a null/undefined value is observed, it indicates it does not apply.
+   */
+  occurs_at?: string | null;
+}
+
+/**
+ * What a feed item is about; fixes the meaning of the item's `metric`.
+ */
+export type FeedItemKind = 'earnings' | 'dividend' | 'split' | 'news' | 'omni';
+
+/**
+ * A feed item's headline number.
+ */
+export interface FeedItemMetric {
+  /**
+   * What the number measures.
+   */
+  type: FeedMetricType;
+
+  /**
+   * The number itself, as a decimal string.
+   */
+  value: string;
+}
+
+/**
+ * What a feed item's number measures.
+ */
+export type FeedMetricType = 'eps_estimate' | 'dividend_amount' | 'split_ratio';
+
+/**
+ * One page of the caller's feed.
+ */
+export interface FeedPage {
+  /**
+   * Feed items, in feed order.
+   */
+  items: Array<FeedItem>;
+
+  /**
+   * Cursor for the page after this one: the last item's id. Absent only when there
+   * are no items to serve. When a null/undefined value is observed, it indicates
+   * that there is no available data.
+   */
+  next_cursor?: string | null;
+}
+
+export interface OmniFeedGetFeedResponse extends Shared.BaseResponse {
+  /**
+   * One page of the caller's feed.
+   */
+  data: FeedPage;
+}
+
+export interface OmniFeedGetFeedParams {
+  /**
+   * Trading account to serve as context. Optional — the feed works without one.
+   */
+  account_id?: number;
+
+  /**
+   * Id of the last item already received; the response continues from the item after
+   * it. Omit to resume from the oldest unseen item.
+   */
+  cursor?: string;
+
+  /**
+   * Maximum number of items to return (1–100, default 20).
+   */
+  limit?: number;
+}
+
+export interface OmniFeedPostFeedEventParams {
+  /**
+   * The event to record.
+   */
+  event: OmniFeedPostFeedEventParams.Event;
+}
+
+export namespace OmniFeedPostFeedEventParams {
+  /**
+   * The event to record.
+   */
+  export interface Event {
+    /**
+     * The feed item the event concerns.
+     */
+    item_id: string;
+
+    /**
+     * What happened.
+     */
+    type: 'seen' | 'click' | 'upvote' | 'downvote';
+  }
+}
+
+export declare namespace OmniFeed {
+  export {
+    type FeedItem as FeedItem,
+    type FeedItemKind as FeedItemKind,
+    type FeedItemMetric as FeedItemMetric,
+    type FeedMetricType as FeedMetricType,
+    type FeedPage as FeedPage,
+    type OmniFeedGetFeedResponse as OmniFeedGetFeedResponse,
+    type OmniFeedGetFeedParams as OmniFeedGetFeedParams,
+    type OmniFeedPostFeedEventParams as OmniFeedPostFeedEventParams,
+  };
+}

package/src/resources/v1/orders.ts

@@ -848,6 +848,36 @@ export interface OrderGetOrdersParams {
    * instruments.
    */
   underlying_instrument_ids?: Array<InstrumentIDOrSymbol>;
+
+  updated_at?: OrderGetOrdersParams.UpdatedAt;
+}
+
+export namespace OrderGetOrdersParams {
+  export interface UpdatedAt {
+    /**
+     * > **Alpha** — this parameter is experimental and may change or be removed at any
+     * > time.
+     */
+    gt?: string;
+
+    /**
+     * > **Alpha** — this parameter is experimental and may change or be removed at any
+     * > time.
+     */
+    gte?: string;
+
+    /**
+     * > **Alpha** — this parameter is experimental and may change or be removed at any
+     * > time.
+     */
+    lt?: string;
+
+    /**
+     * > **Alpha** — this parameter is experimental and may change or be removed at any
+     * > time.
+     */
+    lte?: string;
+  }
 }
 
 export interface OrderReplaceOrderParams {

package/src/resources/v1/screener.ts

@@ -97,18 +97,42 @@ export class Screener extends APIResource {
   }
 
   /**
-   * Update a saved screener configuration.
+   * Partially update a saved screener configuration.
    *
-   * Replaces the screener configuration for the authenticated user. If `name` is
-   * null, the existing name is preserved.
+   * Every field is optional. Omitting a field, or sending it as `null`, leaves the
+   * stored value unchanged. Sending a field's empty value clears it: `columns: []`
+   * clears the stored columns, `sorts: []` clears the stored sort, and `filters: []`
+   * clears the stored filters. `name: ""` is rejected -- a screener's name cannot be
+   * cleared. `shared: false` sets it to `false`; it is a value, not a clear.
+   *
+   * Unknown fields are rejected with a 422.
    *
    * @example
    * ```ts
-   * const response = await client.v1.screener.replaceScreener(
+   * const response = await client.v1.screener.patchScreener(
    *   '550e8400-e29b-41d4-a716-446655440000',
    * );
    * ```
    */
+  patchScreener(
+    screenerID: string,
+    body: ScreenerPatchScreenerParams,
+    options?: RequestOptions,
+  ): APIPromise<ScreenerPatchScreenerResponse> {
+    return this._client.patch(path`/v1/saved-screeners/${screenerID}`, { body, ...options });
+  }
+
+  /**
+   * Update a saved screener configuration.
+   *
+   * Replaces the screener configuration for the authenticated user. If `name` is
+   * null, the existing name is preserved.
+   *
+   * Deprecated -- use `PATCH /saved-screeners/{screener_id}`; PUT replaces omitted
+   * `columns`, `filters` and `sorts` with empty values.
+   *
+   * @deprecated
+   */
   replaceScreener(
     screenerID: string,
     body: ScreenerReplaceScreenerParams,
@@ -745,6 +769,13 @@ export interface ScreenerGetScreenersResponse extends Shared.BaseResponse {
   data: ScreenerEntryList;
 }
 
+export interface ScreenerPatchScreenerResponse extends Shared.BaseResponse {
+  /**
+   * A saved screener configuration entry
+   */
+  data: ScreenerEntry;
+}
+
 export interface ScreenerReplaceScreenerResponse extends Shared.BaseResponse {
   /**
    * A saved screener configuration entry
@@ -784,6 +815,38 @@ export interface ScreenerCreateScreenerParams {
   sorts?: Array<SortSpec> | null;
 }
 
+export interface ScreenerPatchScreenerParams {
+  /**
+   * Structured field references to include when running this screener. Omit or send
+   * `null` to leave unchanged; `[]` clears the stored columns.
+   */
+  columns?: Array<FieldRef> | null;
+
+  /**
+   * Structured search filter criteria. Omit or send `null` to leave unchanged; `[]`
+   * clears the stored filters.
+   */
+  filters?: Array<SearchFilter> | null;
+
+  /**
+   * The name for this screener configuration. Omit or send `null` to leave
+   * unchanged. Cannot be set to an empty string.
+   */
+  name?: string | null;
+
+  /**
+   * Whether any user may fetch this screener by id. Omit or send `null` to leave
+   * unchanged. `false` is a value, not a clear.
+   */
+  shared?: boolean | null;
+
+  /**
+   * Multi-field sort specifications. Omit or send `null` to leave unchanged; `[]`
+   * clears the stored sort.
+   */
+  sorts?: Array<SortSpec> | null;
+}
+
 export interface ScreenerReplaceScreenerParams {
   /**
    * Structured field references to include when running this screener
@@ -880,9 +943,11 @@ export declare namespace Screener {
     type ScreenerGetScreenerByIDResponse as ScreenerGetScreenerByIDResponse,
     type ScreenerGetScreenerCatalogResponse as ScreenerGetScreenerCatalogResponse,
     type ScreenerGetScreenersResponse as ScreenerGetScreenersResponse,
+    type ScreenerPatchScreenerResponse as ScreenerPatchScreenerResponse,
     type ScreenerReplaceScreenerResponse as ScreenerReplaceScreenerResponse,
     type ScreenerSearchScreenerResponse as ScreenerSearchScreenerResponse,
     type ScreenerCreateScreenerParams as ScreenerCreateScreenerParams,
+    type ScreenerPatchScreenerParams as ScreenerPatchScreenerParams,
     type ScreenerReplaceScreenerParams as ScreenerReplaceScreenerParams,
     type ScreenerSearchScreenerParams as ScreenerSearchScreenerParams,
   };

package/src/resources/v1/v1.ts

@@ -13,6 +13,7 @@ import {
   AccountGetAccountsResponse,
   AccountGetPortfolioHistoryParams,
   AccountGetPortfolioHistoryResponse,
+  AccountHolderEntityKind,
   AccountList,
   AccountPatchAccountByIDParams,
   AccountPatchAccountByIDResponse,
@@ -71,6 +72,18 @@ import {
   OptionsContract,
   OptionsContractList,
 } from './instruments';
+import * as OmniFeedAPI from './omni-feed';
+import {
+  FeedItem,
+  FeedItemKind,
+  FeedItemMetric,
+  FeedMetricType,
+  FeedPage,
+  OmniFeed,
+  OmniFeedGetFeedParams,
+  OmniFeedGetFeedResponse,
+  OmniFeedPostFeedEventParams,
+} from './omni-feed';
 import * as OrdersAPI from './orders';
 import {
   Execution,
@@ -158,6 +171,8 @@ import {
   ScreenerGetScreenerByIDResponse,
   ScreenerGetScreenerCatalogResponse,
   ScreenerGetScreenersResponse,
+  ScreenerPatchScreenerParams,
+  ScreenerPatchScreenerResponse,
   ScreenerReplaceScreenerParams,
   ScreenerReplaceScreenerResponse,
   ScreenerRow,
@@ -282,6 +297,7 @@ export class V1 extends APIResource {
   instrumentData: InstrumentDataAPI.InstrumentData = new InstrumentDataAPI.InstrumentData(this._client);
   instruments: InstrumentsAPI.Instruments = new InstrumentsAPI.Instruments(this._client);
   omniAI: OmniAIAPI.OmniAI = new OmniAIAPI.OmniAI(this._client);
+  omniFeed: OmniFeedAPI.OmniFeed = new OmniFeedAPI.OmniFeed(this._client);
   orders: OrdersAPI.Orders = new OrdersAPI.Orders(this._client);
   positions: PositionsAPI.Positions = new PositionsAPI.Positions(this._client);
   privateMarkets: PrivateMarketsAPI.PrivateMarkets = new PrivateMarketsAPI.PrivateMarkets(this._client);
@@ -305,6 +321,7 @@ V1.Calendar = Calendar;
 V1.InstrumentData = InstrumentData;
 V1.Instruments = Instruments;
 V1.OmniAI = OmniAI;
+V1.OmniFeed = OmniFeed;
 V1.Orders = Orders;
 V1.Positions = Positions;
 V1.PrivateMarkets = PrivateMarkets;
@@ -319,6 +336,7 @@ export declare namespace V1 {
     type Account as Account,
     type AccountBalances as AccountBalances,
     type AccountBalancesSod as AccountBalancesSod,
+    type AccountHolderEntityKind as AccountHolderEntityKind,
     type AccountList as AccountList,
     type AccountSettings as AccountSettings,
     type AccountStatus as AccountStatus,
@@ -459,6 +477,18 @@ export declare namespace V1 {
     type SuggestedActionsPayload as SuggestedActionsPayload,
   };
 
+  export {
+    OmniFeed as OmniFeed,
+    type FeedItem as FeedItem,
+    type FeedItemKind as FeedItemKind,
+    type FeedItemMetric as FeedItemMetric,
+    type FeedMetricType as FeedMetricType,
+    type FeedPage as FeedPage,
+    type OmniFeedGetFeedResponse as OmniFeedGetFeedResponse,
+    type OmniFeedGetFeedParams as OmniFeedGetFeedParams,
+    type OmniFeedPostFeedEventParams as OmniFeedPostFeedEventParams,
+  };
+
   export {
     Orders as Orders,
     type Execution as Execution,
@@ -565,9 +595,11 @@ export declare namespace V1 {
     type ScreenerGetScreenerByIDResponse as ScreenerGetScreenerByIDResponse,
     type ScreenerGetScreenerCatalogResponse as ScreenerGetScreenerCatalogResponse,
     type ScreenerGetScreenersResponse as ScreenerGetScreenersResponse,
+    type ScreenerPatchScreenerResponse as ScreenerPatchScreenerResponse,
     type ScreenerReplaceScreenerResponse as ScreenerReplaceScreenerResponse,
     type ScreenerSearchScreenerResponse as ScreenerSearchScreenerResponse,
     type ScreenerCreateScreenerParams as ScreenerCreateScreenerParams,
+    type ScreenerPatchScreenerParams as ScreenerPatchScreenerParams,
     type ScreenerReplaceScreenerParams as ScreenerReplaceScreenerParams,
     type ScreenerSearchScreenerParams as ScreenerSearchScreenerParams,
   };

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.97.0'; // x-release-please-version
+export const VERSION = '0.99.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.97.0";
+export declare const VERSION = "0.99.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.97.0'; // x-release-please-version
+exports.VERSION = '0.99.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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