@clear-street/clearstreet 0.94.0 → 0.95.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/package.json +1 -1
- package/resources/v1/accounts.d.mts +27 -14
- package/resources/v1/accounts.d.mts.map +1 -1
- package/resources/v1/accounts.d.ts +27 -14
- package/resources/v1/accounts.d.ts.map +1 -1
- package/resources/v1/index.d.mts +3 -2
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +3 -2
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +3 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +1 -0
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/instrument-data/market-data.d.mts +38 -0
- package/resources/v1/instrument-data/market-data.d.mts.map +1 -1
- package/resources/v1/instrument-data/market-data.d.ts +38 -0
- package/resources/v1/instrument-data/market-data.d.ts.map +1 -1
- package/resources/v1/omni-ai/index.d.mts +1 -1
- package/resources/v1/omni-ai/index.d.mts.map +1 -1
- package/resources/v1/omni-ai/index.d.ts +1 -1
- package/resources/v1/omni-ai/index.d.ts.map +1 -1
- package/resources/v1/omni-ai/index.js.map +1 -1
- package/resources/v1/omni-ai/index.mjs.map +1 -1
- package/resources/v1/omni-ai/omni-ai.d.mts +157 -3
- package/resources/v1/omni-ai/omni-ai.d.mts.map +1 -1
- package/resources/v1/omni-ai/omni-ai.d.ts +157 -3
- package/resources/v1/omni-ai/omni-ai.d.ts.map +1 -1
- package/resources/v1/omni-ai/omni-ai.js.map +1 -1
- package/resources/v1/omni-ai/omni-ai.mjs.map +1 -1
- package/resources/v1/orders.d.mts +1 -17
- package/resources/v1/orders.d.mts.map +1 -1
- package/resources/v1/orders.d.ts +1 -17
- package/resources/v1/orders.d.ts.map +1 -1
- package/resources/v1/private-markets/index.d.mts +3 -0
- package/resources/v1/private-markets/index.d.mts.map +1 -0
- package/resources/v1/private-markets/index.d.ts +3 -0
- package/resources/v1/private-markets/index.d.ts.map +1 -0
- package/resources/v1/private-markets/index.js +9 -0
- package/resources/v1/private-markets/index.js.map +1 -0
- package/resources/v1/private-markets/index.mjs +4 -0
- package/resources/v1/private-markets/index.mjs.map +1 -0
- package/resources/v1/private-markets/offerings.d.mts +369 -0
- package/resources/v1/private-markets/offerings.d.mts.map +1 -0
- package/resources/v1/private-markets/offerings.d.ts +369 -0
- package/resources/v1/private-markets/offerings.d.ts.map +1 -0
- package/resources/v1/private-markets/offerings.js +46 -0
- package/resources/v1/private-markets/offerings.js.map +1 -0
- package/resources/v1/private-markets/offerings.mjs +42 -0
- package/resources/v1/private-markets/offerings.mjs.map +1 -0
- package/resources/v1/private-markets/private-markets.d.mts +10 -0
- package/resources/v1/private-markets/private-markets.d.mts.map +1 -0
- package/resources/v1/private-markets/private-markets.d.ts +10 -0
- package/resources/v1/private-markets/private-markets.d.ts.map +1 -0
- package/resources/v1/private-markets/private-markets.js +17 -0
- package/resources/v1/private-markets/private-markets.js.map +1 -0
- package/resources/v1/private-markets/private-markets.mjs +12 -0
- package/resources/v1/private-markets/private-markets.mjs.map +1 -0
- package/resources/v1/private-markets.d.mts +2 -0
- package/resources/v1/private-markets.d.mts.map +1 -0
- package/resources/v1/private-markets.d.ts +2 -0
- package/resources/v1/private-markets.d.ts.map +1 -0
- package/resources/v1/private-markets.js +6 -0
- package/resources/v1/private-markets.js.map +1 -0
- package/resources/v1/private-markets.mjs +3 -0
- package/resources/v1/private-markets.mjs.map +1 -0
- package/resources/v1/screener.d.mts +3 -0
- package/resources/v1/screener.d.mts.map +1 -1
- package/resources/v1/screener.d.ts +3 -0
- package/resources/v1/screener.d.ts.map +1 -1
- package/resources/v1/screener.js +3 -0
- package/resources/v1/screener.js.map +1 -1
- package/resources/v1/screener.mjs +3 -0
- package/resources/v1/screener.mjs.map +1 -1
- package/resources/v1/v1.d.mts +8 -4
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +8 -4
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +4 -0
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +4 -0
- package/resources/v1/v1.mjs.map +1 -1
- package/src/resources/v1/accounts.ts +27 -14
- package/src/resources/v1/index.ts +3 -1
- package/src/resources/v1/instrument-data/market-data.ts +44 -0
- package/src/resources/v1/omni-ai/index.ts +2 -0
- package/src/resources/v1/omni-ai/omni-ai.ts +187 -2
- package/src/resources/v1/orders.ts +0 -19
- package/src/resources/v1/private-markets/index.ts +27 -0
- package/src/resources/v1/private-markets/offerings.ts +477 -0
- package/src/resources/v1/private-markets/private-markets.ts +61 -0
- package/src/resources/v1/private-markets.ts +3 -0
- package/src/resources/v1/screener.ts +3 -0
- package/src/resources/v1/v1.ts +10 -2
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -41,9 +41,11 @@ export {
|
|
|
41
41
|
type OpenEntitlementConsentAction,
|
|
42
42
|
type OpenScreenerAction,
|
|
43
43
|
type PrefillCancelOrderAction,
|
|
44
|
+
type PrefillCancelOrderRequest,
|
|
44
45
|
type PrefillModifyOrderAction,
|
|
45
46
|
type PrefillModifyOrderRequest,
|
|
46
47
|
type PrefillNewOrderAction,
|
|
48
|
+
type PrefillNewOrderRequest,
|
|
47
49
|
type PrefillOrderAction,
|
|
48
50
|
type PromptButtonAction,
|
|
49
51
|
type StructuredAction,
|
|
@@ -90,6 +90,13 @@ export interface ActionButton {
|
|
|
90
90
|
*/
|
|
91
91
|
label: string;
|
|
92
92
|
|
|
93
|
+
/**
|
|
94
|
+
* Interaction-tracking identity. Absent on messages created before tracking. When
|
|
95
|
+
* a null/undefined value is observed, it indicates that there is no available
|
|
96
|
+
* data.
|
|
97
|
+
*/
|
|
98
|
+
itemId?: string | null;
|
|
99
|
+
|
|
93
100
|
/**
|
|
94
101
|
* Follow-up prompt to submit as the next user message. When a null/undefined value
|
|
95
102
|
* is observed, it indicates it does not apply.
|
|
@@ -112,6 +119,11 @@ export interface ChartPayload {
|
|
|
112
119
|
*/
|
|
113
120
|
chartId: string;
|
|
114
121
|
|
|
122
|
+
/**
|
|
123
|
+
* Whether the current user clicked this chart.
|
|
124
|
+
*/
|
|
125
|
+
clicked: boolean;
|
|
126
|
+
|
|
115
127
|
/**
|
|
116
128
|
* Buttons associated with this chart.
|
|
117
129
|
*/
|
|
@@ -122,6 +134,13 @@ export interface ChartPayload {
|
|
|
122
134
|
* observed, it indicates it does not apply.
|
|
123
135
|
*/
|
|
124
136
|
dataChart?: DataChart | null;
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* Interaction-tracking identity. Absent on messages created before tracking. When
|
|
140
|
+
* a null/undefined value is observed, it indicates that there is no available
|
|
141
|
+
* data.
|
|
142
|
+
*/
|
|
143
|
+
itemId?: string | null;
|
|
125
144
|
}
|
|
126
145
|
|
|
127
146
|
/**
|
|
@@ -172,6 +191,23 @@ export interface ContentPartStructuredActionPayload {
|
|
|
172
191
|
action: StructuredAction;
|
|
173
192
|
|
|
174
193
|
action_id: string;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* Whether the current user clicked this action.
|
|
197
|
+
*/
|
|
198
|
+
clicked: boolean;
|
|
199
|
+
|
|
200
|
+
/**
|
|
201
|
+
* IDs of nested items clicked by the current user.
|
|
202
|
+
*/
|
|
203
|
+
clicked_item_ids?: Array<string>;
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* Interaction-tracking identity. Absent on messages created before tracking. When
|
|
207
|
+
* a null/undefined value is observed, it indicates that there is no available
|
|
208
|
+
* data.
|
|
209
|
+
*/
|
|
210
|
+
item_id?: string | null;
|
|
175
211
|
}
|
|
176
212
|
|
|
177
213
|
/**
|
|
@@ -230,6 +266,13 @@ export interface OpenChartAction {
|
|
|
230
266
|
*/
|
|
231
267
|
extras?: unknown;
|
|
232
268
|
|
|
269
|
+
/**
|
|
270
|
+
* Interaction-tracking identity. Absent on messages created before tracking. When
|
|
271
|
+
* a null/undefined value is observed, it indicates that there is no available
|
|
272
|
+
* data.
|
|
273
|
+
*/
|
|
274
|
+
item_id?: string | null;
|
|
275
|
+
|
|
233
276
|
/**
|
|
234
277
|
* Chart timeframe (e.g., "1D", "1W", "1M", "3M", "1Y", "5Y") When a null/undefined
|
|
235
278
|
* value is observed, it indicates it does not apply.
|
|
@@ -251,6 +294,13 @@ export interface OpenEntitlementConsentAction {
|
|
|
251
294
|
entitlement_codes: Array<EntitlementCode>;
|
|
252
295
|
|
|
253
296
|
reason: string;
|
|
297
|
+
|
|
298
|
+
/**
|
|
299
|
+
* Interaction-tracking identity. Absent on messages created before tracking. When
|
|
300
|
+
* a null/undefined value is observed, it indicates that there is no available
|
|
301
|
+
* data.
|
|
302
|
+
*/
|
|
303
|
+
item_id?: string | null;
|
|
254
304
|
}
|
|
255
305
|
|
|
256
306
|
/**
|
|
@@ -268,6 +318,13 @@ export interface OpenScreenerAction {
|
|
|
268
318
|
*/
|
|
269
319
|
columns?: Array<string> | null;
|
|
270
320
|
|
|
321
|
+
/**
|
|
322
|
+
* Interaction-tracking identity. Absent on messages created before tracking. When
|
|
323
|
+
* a null/undefined value is observed, it indicates that there is no available
|
|
324
|
+
* data.
|
|
325
|
+
*/
|
|
326
|
+
item_id?: string | null;
|
|
327
|
+
|
|
271
328
|
/**
|
|
272
329
|
* Optional page size. When a null/undefined value is observed, it indicates it
|
|
273
330
|
* does not apply.
|
|
@@ -294,7 +351,32 @@ export interface PrefillCancelOrderAction {
|
|
|
294
351
|
/**
|
|
295
352
|
* Orders to cancel using the same identifiers required by the cancel-order API.
|
|
296
353
|
*/
|
|
297
|
-
orders: Array<
|
|
354
|
+
orders: Array<PrefillCancelOrderRequest>;
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
/**
|
|
358
|
+
* Request to cancel an existing order
|
|
359
|
+
*
|
|
360
|
+
* Note: In the API, order cancellation is done via DELETE request without a body.
|
|
361
|
+
* The order_id and account_id come from the URL path parameters.
|
|
362
|
+
*/
|
|
363
|
+
export interface PrefillCancelOrderRequest {
|
|
364
|
+
/**
|
|
365
|
+
* Account ID (from path parameter)
|
|
366
|
+
*/
|
|
367
|
+
account_id: number;
|
|
368
|
+
|
|
369
|
+
/**
|
|
370
|
+
* Order ID to cancel (from path parameter)
|
|
371
|
+
*/
|
|
372
|
+
order_id: string;
|
|
373
|
+
|
|
374
|
+
/**
|
|
375
|
+
* Interaction-tracking identity. Absent on messages created before tracking. When
|
|
376
|
+
* a null/undefined value is observed, it indicates that there is no available
|
|
377
|
+
* data.
|
|
378
|
+
*/
|
|
379
|
+
item_id?: string | null;
|
|
298
380
|
}
|
|
299
381
|
|
|
300
382
|
/**
|
|
@@ -318,6 +400,13 @@ export interface PrefillModifyOrderRequest {
|
|
|
318
400
|
*/
|
|
319
401
|
account_id?: number;
|
|
320
402
|
|
|
403
|
+
/**
|
|
404
|
+
* Interaction-tracking identity. Absent on messages created before tracking. When
|
|
405
|
+
* a null/undefined value is observed, it indicates that there is no available
|
|
406
|
+
* data.
|
|
407
|
+
*/
|
|
408
|
+
item_id?: string | null;
|
|
409
|
+
|
|
321
410
|
/**
|
|
322
411
|
* New limit offset for trailing stop-limit orders (signed)
|
|
323
412
|
*/
|
|
@@ -361,7 +450,96 @@ export interface PrefillNewOrderAction {
|
|
|
361
450
|
/**
|
|
362
451
|
* Orders to prefill using the same shape accepted by the orders API.
|
|
363
452
|
*/
|
|
364
|
-
orders: Array<
|
|
453
|
+
orders: Array<PrefillNewOrderRequest>;
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
/**
|
|
457
|
+
* Request to submit a new order (PlaceOrderRequest from spec)
|
|
458
|
+
*/
|
|
459
|
+
export interface PrefillNewOrderRequest {
|
|
460
|
+
/**
|
|
461
|
+
* Type of order
|
|
462
|
+
*/
|
|
463
|
+
order_type: OrdersAPI.RequestOrderType;
|
|
464
|
+
|
|
465
|
+
/**
|
|
466
|
+
* Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported).
|
|
467
|
+
* For OPTION (single-leg): contracts (must be an integer)
|
|
468
|
+
*/
|
|
469
|
+
quantity: string;
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* Side of the order
|
|
473
|
+
*/
|
|
474
|
+
side: OrdersAPI.Side;
|
|
475
|
+
|
|
476
|
+
/**
|
|
477
|
+
* Time in force
|
|
478
|
+
*/
|
|
479
|
+
time_in_force: OrdersAPI.RequestTimeInForce;
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* Optional client-provided unique ID (idempotency). Required to be unique per
|
|
483
|
+
* account.
|
|
484
|
+
*/
|
|
485
|
+
id?: string | null;
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* The timestamp when the order should expire (UTC). Required when time_in_force is
|
|
489
|
+
* GOOD_TILL_DATE.
|
|
490
|
+
*/
|
|
491
|
+
expires_at?: string | null;
|
|
492
|
+
|
|
493
|
+
/**
|
|
494
|
+
* Allow trading outside regular trading hours. Some brokers disallow options
|
|
495
|
+
* outside RTH.
|
|
496
|
+
*/
|
|
497
|
+
extended_hours?: boolean | null;
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either
|
|
501
|
+
* `symbol` or `instrument_id` must be provided.
|
|
502
|
+
*/
|
|
503
|
+
instrument_id?: OrdersAPI.InstrumentIDOrSymbol | null;
|
|
504
|
+
|
|
505
|
+
/**
|
|
506
|
+
* Interaction-tracking identity. Absent on messages created before tracking. When
|
|
507
|
+
* a null/undefined value is observed, it indicates that there is no available
|
|
508
|
+
* data.
|
|
509
|
+
*/
|
|
510
|
+
item_id?: string | null;
|
|
511
|
+
|
|
512
|
+
/**
|
|
513
|
+
* Limit offset for trailing stop-limit orders (signed)
|
|
514
|
+
*/
|
|
515
|
+
limit_offset?: string | null;
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* Limit price (required for LIMIT and STOP_LIMIT orders)
|
|
519
|
+
*/
|
|
520
|
+
limit_price?: string | null;
|
|
521
|
+
|
|
522
|
+
/**
|
|
523
|
+
* Stop price (required for STOP and STOP_LIMIT orders)
|
|
524
|
+
*/
|
|
525
|
+
stop_price?: string | null;
|
|
526
|
+
|
|
527
|
+
/**
|
|
528
|
+
* Trading symbol. For equities, use the ticker symbol (e.g., "TSLA"). For options,
|
|
529
|
+
* use the OSI symbol (e.g., "TSLA 250117C00190000"). Either `symbol` or
|
|
530
|
+
* `instrument_id` must be provided.
|
|
531
|
+
*/
|
|
532
|
+
symbol?: string | null;
|
|
533
|
+
|
|
534
|
+
/**
|
|
535
|
+
* Trailing offset amount (required for trailing orders)
|
|
536
|
+
*/
|
|
537
|
+
trailing_offset?: string | null;
|
|
538
|
+
|
|
539
|
+
/**
|
|
540
|
+
* Trailing offset type (PRICE or PERCENT_BPS)
|
|
541
|
+
*/
|
|
542
|
+
trailing_offset_type?: OrdersAPI.TrailingOffsetType | null;
|
|
365
543
|
}
|
|
366
544
|
|
|
367
545
|
/**
|
|
@@ -482,6 +660,11 @@ export interface SuggestedActionsPayload {
|
|
|
482
660
|
* Ordered message-level buttons.
|
|
483
661
|
*/
|
|
484
662
|
actionButtons?: Array<ActionButton>;
|
|
663
|
+
|
|
664
|
+
/**
|
|
665
|
+
* IDs of buttons clicked by the current user.
|
|
666
|
+
*/
|
|
667
|
+
clickedItemIds?: Array<string>;
|
|
485
668
|
}
|
|
486
669
|
|
|
487
670
|
OmniAI.Entitlements = Entitlements;
|
|
@@ -508,9 +691,11 @@ export declare namespace OmniAI {
|
|
|
508
691
|
type OpenEntitlementConsentAction as OpenEntitlementConsentAction,
|
|
509
692
|
type OpenScreenerAction as OpenScreenerAction,
|
|
510
693
|
type PrefillCancelOrderAction as PrefillCancelOrderAction,
|
|
694
|
+
type PrefillCancelOrderRequest as PrefillCancelOrderRequest,
|
|
511
695
|
type PrefillModifyOrderAction as PrefillModifyOrderAction,
|
|
512
696
|
type PrefillModifyOrderRequest as PrefillModifyOrderRequest,
|
|
513
697
|
type PrefillNewOrderAction as PrefillNewOrderAction,
|
|
698
|
+
type PrefillNewOrderRequest as PrefillNewOrderRequest,
|
|
514
699
|
type PrefillOrderAction as PrefillOrderAction,
|
|
515
700
|
type PromptButtonAction as PromptButtonAction,
|
|
516
701
|
type StructuredAction as StructuredAction,
|
|
@@ -157,24 +157,6 @@ export class Orders extends APIResource {
|
|
|
157
157
|
}
|
|
158
158
|
}
|
|
159
159
|
|
|
160
|
-
/**
|
|
161
|
-
* Request to cancel an existing order
|
|
162
|
-
*
|
|
163
|
-
* Note: In the API, order cancellation is done via DELETE request without a body.
|
|
164
|
-
* The order_id and account_id come from the URL path parameters.
|
|
165
|
-
*/
|
|
166
|
-
export interface CancelOrderRequest {
|
|
167
|
-
/**
|
|
168
|
-
* Account ID (from path parameter)
|
|
169
|
-
*/
|
|
170
|
-
account_id: number;
|
|
171
|
-
|
|
172
|
-
/**
|
|
173
|
-
* Order ID to cancel (from path parameter)
|
|
174
|
-
*/
|
|
175
|
-
order_id: string;
|
|
176
|
-
}
|
|
177
|
-
|
|
178
160
|
/**
|
|
179
161
|
* Represents a single fill of an order for an account.
|
|
180
162
|
*/
|
|
@@ -895,7 +877,6 @@ export interface OrderSubmitOrdersParams {
|
|
|
895
877
|
|
|
896
878
|
export declare namespace Orders {
|
|
897
879
|
export {
|
|
898
|
-
type CancelOrderRequest as CancelOrderRequest,
|
|
899
880
|
type Execution as Execution,
|
|
900
881
|
type ExecutionList as ExecutionList,
|
|
901
882
|
type InstrumentIDOrSymbol as InstrumentIDOrSymbol,
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
export {
|
|
4
|
+
Offerings,
|
|
5
|
+
type Currency,
|
|
6
|
+
type MetricUnit,
|
|
7
|
+
type MetricValueType,
|
|
8
|
+
type OfferingCard,
|
|
9
|
+
type OfferingCardList,
|
|
10
|
+
type OfferingClass,
|
|
11
|
+
type OfferingCompany,
|
|
12
|
+
type OfferingDetail,
|
|
13
|
+
type OfferingDocumentResource,
|
|
14
|
+
type OfferingDocumentType,
|
|
15
|
+
type OfferingHighlight,
|
|
16
|
+
type OfferingKeyRisk,
|
|
17
|
+
type OfferingParticipantResource,
|
|
18
|
+
type OfferingSpv,
|
|
19
|
+
type ParticipantRole,
|
|
20
|
+
type SpvStatus,
|
|
21
|
+
type ValuationBasis,
|
|
22
|
+
type OfferingGetOfferingByIDResponse,
|
|
23
|
+
type OfferingGetOfferingsResponse,
|
|
24
|
+
type OfferingGetOfferingByIDParams,
|
|
25
|
+
type OfferingGetOfferingsParams,
|
|
26
|
+
} from './offerings';
|
|
27
|
+
export { PrivateMarkets } from './private-markets';
|