@clear-street/clearstreet 0.102.0 → 0.104.0

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

@@ -13,10 +13,16 @@ import {
   EntitlementCreateEntitlementsResponse,
   EntitlementDeleteEntitlementResponse,
   EntitlementGetEntitlementAgreementsResponse,
+  EntitlementGetEntitlementStatusParams,
+  EntitlementGetEntitlementStatusResponse,
   EntitlementGetEntitlementsParams,
   EntitlementGetEntitlementsResponse,
+  EntitlementOptOutEntitlementsParams,
+  EntitlementOptOutEntitlementsResponse,
   EntitlementResource,
   EntitlementResourceList,
+  EntitlementStatusResource,
+  EntitlementStatusResourceList,
   Entitlements,
 } from './entitlements';
 import * as MessagesAPI from './messages';
@@ -533,9 +539,10 @@ export interface PrefillNewOrderRequest {
   stop_price?: string | null;
 
   /**
-   * Optional execution strategy. One of `SOR`, `VWAP`, or `TWAP`. Defaults to `SOR`.
-   * `VWAP` and `TWAP` are supported only on `MARKET` and `LIMIT` orders with `DAY`
-   * time-in-force, and are not supported on OTC common-stock orders.
+   * Optional execution strategy. One of `SOR`, `VWAP`, `TWAP`, or `DMA`. Defaults to
+   * `SOR`, the only strategy OTC common-stock orders support. `VWAP` and `TWAP` are
+   * supported only on `MARKET` and `LIMIT` orders, and `DMA` only on `LIMIT` orders;
+   * all three require `DAY` time-in-force.
    */
   strategy?: OrdersAPI.OrderStrategy | null;
 
@@ -725,12 +732,18 @@ export declare namespace OmniAI {
     type EntitlementAgreementResourceList as EntitlementAgreementResourceList,
     type EntitlementResource as EntitlementResource,
     type EntitlementResourceList as EntitlementResourceList,
+    type EntitlementStatusResource as EntitlementStatusResource,
+    type EntitlementStatusResourceList as EntitlementStatusResourceList,
     type EntitlementCreateEntitlementsResponse as EntitlementCreateEntitlementsResponse,
     type EntitlementDeleteEntitlementResponse as EntitlementDeleteEntitlementResponse,
     type EntitlementGetEntitlementAgreementsResponse as EntitlementGetEntitlementAgreementsResponse,
+    type EntitlementGetEntitlementStatusResponse as EntitlementGetEntitlementStatusResponse,
     type EntitlementGetEntitlementsResponse as EntitlementGetEntitlementsResponse,
+    type EntitlementOptOutEntitlementsResponse as EntitlementOptOutEntitlementsResponse,
     type EntitlementCreateEntitlementsParams as EntitlementCreateEntitlementsParams,
+    type EntitlementGetEntitlementStatusParams as EntitlementGetEntitlementStatusParams,
     type EntitlementGetEntitlementsParams as EntitlementGetEntitlementsParams,
+    type EntitlementOptOutEntitlementsParams as EntitlementOptOutEntitlementsParams,
   };
 
   export {

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

@@ -138,8 +138,10 @@ export class Threads extends APIResource {
   }
 
   /**
-   * List authorized conversation metadata, newest first. Use `page_size` and
-   * `page_token` for pagination, and the messages endpoint for conversation history.
+   * List authorized conversation metadata, most recently active first (by
+   * `updated_at`, which a new message moves). Use `page_size` and `page_token` for
+   * pagination, and the messages endpoint for conversation history. A thread that
+   * gets a message while you page moves to the first page.
    *
    * With `account_id`, list only conversations linked to that account and require
    * current account access. Without it, list only conversations with no linked
@@ -323,6 +325,10 @@ export interface Thread {
 
   title: string;
 
+  /**
+   * Time of the last activity: a new message in the thread or a change to the
+   * thread.
+   */
   updated_at: string;
 }
 

package/src/resources/v1/orders.ts

@@ -309,9 +309,10 @@ export interface NewOrderRequest {
   stop_price?: string | null;
 
   /**
-   * Optional execution strategy. One of `SOR`, `VWAP`, or `TWAP`. Defaults to `SOR`.
-   * `VWAP` and `TWAP` are supported only on `MARKET` and `LIMIT` orders with `DAY`
-   * time-in-force, and are not supported on OTC common-stock orders.
+   * Optional execution strategy. One of `SOR`, `VWAP`, `TWAP`, or `DMA`. Defaults to
+   * `SOR`, the only strategy OTC common-stock orders support. `VWAP` and `TWAP` are
+   * supported only on `MARKET` and `LIMIT` orders, and `DMA` only on `LIMIT` orders;
+   * all three require `DAY` time-in-force.
    */
   strategy?: OrderStrategy | null;
 
@@ -553,7 +554,12 @@ export namespace Order {
     /**
      * Execution strategy type.
      */
-    type: string;
+    type: 'SOR' | 'VWAP' | 'TWAP' | 'DMA';
+
+    /**
+     * Venue code the order is routed to. DMA only.
+     */
+    destination?: string;
 
     /**
      * UTC timestamp (RFC 3339) at which execution ends.
@@ -595,9 +601,13 @@ export type OrderStatus =
 
 /**
  * Optional execution strategy controlling how the order is worked in the market.
- * Omit to use standard routing. One of `SOR`, `VWAP`, or `TWAP`.
+ * Omit to use standard routing. One of `SOR`, `VWAP`, `TWAP`, or `DMA`.
  */
-export type OrderStrategy = OrderStrategy.Type | OrderStrategy.UnionMember1 | OrderStrategy.UnionMember2;
+export type OrderStrategy =
+  | OrderStrategy.Type
+  | OrderStrategy.UnionMember1
+  | OrderStrategy.UnionMember2
+  | OrderStrategy.UnionMember3;
 
 export namespace OrderStrategy {
   /**
@@ -655,6 +665,21 @@ export namespace OrderStrategy {
      */
     start_at?: string;
   }
+
+  /**
+   * Direct Market Access. Routes the order straight to the named venue.
+   */
+  export interface UnionMember3 {
+    /**
+     * Venue code the order is routed to.
+     */
+    destination: string;
+
+    /**
+     * Execution strategy type.
+     */
+    type: 'DMA';
+  }
 }
 
 /**

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

@@ -1,28 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  Companies,
-  type CompanyCategory,
-  type CompanyCitation,
-  type CompanyCustomer,
-  type CompanyDetail,
-  type CompanyDocumentPreview,
-  type CompanyDocumentRelation,
-  type CompanyDocumentResource,
-  type CompanyDocumentType,
-  type CompanyHeadquarters,
-  type CompanyLegalEntity,
-  type CompanyMetricPoint,
-  type CompanyMetricSeries,
-  type CompanyNarrativeSection,
-  type CompanyPerson,
-  type CompanyPersonRole,
-  type CompanyProfileResource,
-  type CompanySocialLink,
-  type CompanySocialType,
-  type MetricFrequency,
-  type MetricKey,
-} from './companies';
 export {
   Iois,
   type IoiCompanyResource,
@@ -31,6 +8,13 @@ export {
   type IoiOfferingResource,
   type IoiResource,
   type NdaAcceptanceResource,
+  type IoisCreateIoiResponse,
+  type IoisGetIoisResponse,
+  type IoisUpdateIoiResponse,
+  type IoisCreateIoiParams,
+  type IoisDeleteIoiParams,
+  type IoisGetIoisParams,
+  type IoisUpdateIoiParams,
 } from './iois';
 export {
   Offerings,
@@ -59,23 +43,33 @@ export {
 } from './offerings';
 export {
   PrivateMarkets,
-  type PrivateMarketCreateIoiResponse,
-  type PrivateMarketGetCompanyByIDResponse,
-  type PrivateMarketGetIoisResponse,
-  type PrivateMarketGetSpvByIDResponse,
-  type PrivateMarketUpdateIoiResponse,
-  type PrivateMarketCreateIoiParams,
-  type PrivateMarketDeleteIoiParams,
-  type PrivateMarketGetCompanyByIDParams,
-  type PrivateMarketGetIoisParams,
-  type PrivateMarketGetSpvByIDParams,
-  type PrivateMarketUpdateIoiParams,
-} from './private-markets';
-export {
-  Spvs,
   type ChargedBy,
+  type CompanyCategory,
+  type CompanyCitation,
+  type CompanyCustomer,
+  type CompanyDetail,
+  type CompanyDocumentPreview,
+  type CompanyDocumentRelation,
+  type CompanyDocumentResource,
+  type CompanyDocumentType,
+  type CompanyHeadquarters,
+  type CompanyLegalEntity,
+  type CompanyMetricPoint,
+  type CompanyMetricSeries,
+  type CompanyNarrativeSection,
+  type CompanyPerson,
+  type CompanyPersonRole,
+  type CompanyProfileResource,
+  type CompanySocialLink,
+  type CompanySocialType,
   type FeeFrequency,
   type FeeType,
+  type MetricFrequency,
+  type MetricKey,
   type SpvDetail,
   type SpvFeeTermResource,
-} from './spvs';
+  type PrivateMarketGetCompanyByIDResponse,
+  type PrivateMarketGetSpvByIDResponse,
+  type PrivateMarketGetCompanyByIDParams,
+  type PrivateMarketGetSpvByIDParams,
+} from './private-markets';

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

@@ -1,9 +1,95 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as Shared from '../../shared';
 import * as OfferingsAPI from './offerings';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
-export class Iois extends APIResource {}
+/**
+ * Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.
+ */
+export class Iois extends APIResource {
+  /**
+   * Create an IOI for a visible upcoming offering.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.privateMarkets.iois.createIoi({
+   *     account_id: 0,
+   *     notional_amount: '100000.00',
+   *     offering_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   });
+   * ```
+   */
+  createIoi(params: IoisCreateIoiParams, options?: RequestOptions): APIPromise<IoisCreateIoiResponse> {
+    const { account_id, ...body } = params;
+    return this._client.post('/v1/private-markets/iois', { query: { account_id }, body, ...options });
+  }
+
+  /**
+   * Withdraw a live IOI. Repeating a withdrawal returns 404.
+   *
+   * @example
+   * ```ts
+   * await client.v1.privateMarkets.iois.deleteIoi(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { account_id: 0 },
+   * );
+   * ```
+   */
+  deleteIoi(ioiID: string, params: IoisDeleteIoiParams, options?: RequestOptions): APIPromise<void> {
+    const { account_id } = params;
+    return this._client.delete(path`/v1/private-markets/iois/${ioiID}`, {
+      query: { account_id },
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * List every live IOI for the caller's account-holder entity.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.privateMarkets.iois.getIois({
+   *     account_id: 0,
+   *   });
+   * ```
+   */
+  getIois(query: IoisGetIoisParams, options?: RequestOptions): APIPromise<IoisGetIoisResponse> {
+    return this._client.get('/v1/private-markets/iois', { query, ...options });
+  }
+
+  /**
+   * Update an IOI's notional, accepting the current NDA revision when required.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.privateMarkets.iois.updateIoi(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { account_id: 0, notional_amount: '125000.00' },
+   *   );
+   * ```
+   */
+  updateIoi(
+    ioiID: string,
+    params: IoisUpdateIoiParams,
+    options?: RequestOptions,
+  ): APIPromise<IoisUpdateIoiResponse> {
+    const { account_id, ...body } = params;
+    return this._client.patch(path`/v1/private-markets/iois/${ioiID}`, {
+      query: { account_id },
+      body,
+      ...options,
+    });
+  }
+}
 
 /**
  * Company identity embedded in an IOI list item.
@@ -79,6 +165,117 @@ export interface NdaAcceptanceResource {
   version: number;
 }
 
+export interface IoisCreateIoiResponse extends Shared.BaseResponse {
+  /**
+   * IOI list item with the campaign identity needed to render it.
+   */
+  data: IoiListingResource;
+}
+
+export interface IoisGetIoisResponse extends Shared.BaseResponse {
+  data: IoiListingResourceList;
+}
+
+export interface IoisUpdateIoiResponse extends Shared.BaseResponse {
+  /**
+   * IOI list item with the campaign identity needed to render it.
+   */
+  data: IoiListingResource;
+}
+
+export interface IoisCreateIoiParams {
+  /**
+   * Query param
+   */
+  account_id: number;
+
+  /**
+   * Body param
+   */
+  notional_amount: string;
+
+  /**
+   * Body param
+   */
+  offering_id: string;
+
+  /**
+   * Body param: Required only when the offering's attached SPV has an NDA agreement.
+   */
+  nda_acceptance?: IoisCreateIoiParams.NdaAcceptance | null;
+}
+
+export namespace IoisCreateIoiParams {
+  /**
+   * Required only when the offering's attached SPV has an NDA agreement.
+   */
+  export interface NdaAcceptance {
+    /**
+     * Must be true; confirms affirmative assent.
+     */
+    accepted: boolean;
+
+    /**
+     * Exact agreement id returned by offering detail.
+     */
+    agreement_id: string;
+
+    /**
+     * Must be true; confirms the signer may bind the account-holder entity.
+     */
+    authority_confirmed: boolean;
+  }
+}
+
+export interface IoisDeleteIoiParams {
+  account_id: number;
+}
+
+export interface IoisGetIoisParams {
+  account_id: number;
+}
+
+export interface IoisUpdateIoiParams {
+  /**
+   * Query param
+   */
+  account_id: number;
+
+  /**
+   * Body param
+   */
+  notional_amount: string;
+
+  /**
+   * Body param: Required when the SPV's current NDA version is newer than the IOI's
+   * latest acceptance. Irrelevant acceptances are rejected.
+   */
+  nda_acceptance?: IoisUpdateIoiParams.NdaAcceptance | null;
+}
+
+export namespace IoisUpdateIoiParams {
+  /**
+   * Required when the SPV's current NDA version is newer than the IOI's latest
+   * acceptance. Irrelevant acceptances are rejected.
+   */
+  export interface NdaAcceptance {
+    /**
+     * Must be true; confirms affirmative assent.
+     */
+    accepted: boolean;
+
+    /**
+     * Exact agreement id returned by offering detail.
+     */
+    agreement_id: string;
+
+    /**
+     * Must be true; confirms the signer may bind the account-holder entity.
+     */
+    authority_confirmed: boolean;
+  }
+}
+
 export declare namespace Iois {
   export {
     type IoiCompanyResource as IoiCompanyResource,
@@ -87,5 +284,12 @@ export declare namespace Iois {
     type IoiOfferingResource as IoiOfferingResource,
     type IoiResource as IoiResource,
     type NdaAcceptanceResource as NdaAcceptanceResource,
+    type IoisCreateIoiResponse as IoisCreateIoiResponse,
+    type IoisGetIoisResponse as IoisGetIoisResponse,
+    type IoisUpdateIoiResponse as IoisUpdateIoiResponse,
+    type IoisCreateIoiParams as IoisCreateIoiParams,
+    type IoisDeleteIoiParams as IoisDeleteIoiParams,
+    type IoisGetIoisParams as IoisGetIoisParams,
+    type IoisUpdateIoiParams as IoisUpdateIoiParams,
   };
 }