@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
|
@@ -96,22 +96,6 @@ export declare class Orders extends APIResource {
|
|
|
96
96
|
*/
|
|
97
97
|
submitOrders(accountID: number, params: OrderSubmitOrdersParams, options?: RequestOptions): APIPromise<OrderSubmitOrdersResponse>;
|
|
98
98
|
}
|
|
99
|
-
/**
|
|
100
|
-
* Request to cancel an existing order
|
|
101
|
-
*
|
|
102
|
-
* Note: In the API, order cancellation is done via DELETE request without a body.
|
|
103
|
-
* The order_id and account_id come from the URL path parameters.
|
|
104
|
-
*/
|
|
105
|
-
export interface CancelOrderRequest {
|
|
106
|
-
/**
|
|
107
|
-
* Account ID (from path parameter)
|
|
108
|
-
*/
|
|
109
|
-
account_id: number;
|
|
110
|
-
/**
|
|
111
|
-
* Order ID to cancel (from path parameter)
|
|
112
|
-
*/
|
|
113
|
-
order_id: string;
|
|
114
|
-
}
|
|
115
99
|
/**
|
|
116
100
|
* Represents a single fill of an order for an account.
|
|
117
101
|
*/
|
|
@@ -661,6 +645,6 @@ export interface OrderSubmitOrdersParams {
|
|
|
661
645
|
orders: Array<NewOrderRequest>;
|
|
662
646
|
}
|
|
663
647
|
export declare namespace Orders {
|
|
664
|
-
export { type
|
|
648
|
+
export { type Execution as Execution, type ExecutionList as ExecutionList, type InstrumentIDOrSymbol as InstrumentIDOrSymbol, type NewOrderRequest as NewOrderRequest, type Order as Order, type OrderList as OrderList, type OrderStatus as OrderStatus, type OrderType as OrderType, type QueueState as QueueState, type ReplaceOrderRequest as ReplaceOrderRequest, type RequestOrderType as RequestOrderType, type RequestTimeInForce as RequestTimeInForce, type Side as Side, type TimeInForce as TimeInForce, type TrailingOffsetType as TrailingOffsetType, type OrderCancelAllOpenOrdersResponse as OrderCancelAllOpenOrdersResponse, type OrderCancelOpenOrderResponse as OrderCancelOpenOrderResponse, type OrderGetExecutionsResponse as OrderGetExecutionsResponse, type OrderGetOrderByIDResponse as OrderGetOrderByIDResponse, type OrderGetOrdersResponse as OrderGetOrdersResponse, type OrderReplaceOrderResponse as OrderReplaceOrderResponse, type OrderSubmitOrdersResponse as OrderSubmitOrdersResponse, type OrderCancelAllOpenOrdersParams as OrderCancelAllOpenOrdersParams, type OrderCancelOpenOrderParams as OrderCancelOpenOrderParams, type OrderGetExecutionsParams as OrderGetExecutionsParams, type OrderGetOrderByIDParams as OrderGetOrderByIDParams, type OrderGetOrdersParams as OrderGetOrdersParams, type OrderReplaceOrderParams as OrderReplaceOrderParams, type OrderSubmitOrdersParams as OrderSubmitOrdersParams, };
|
|
665
649
|
}
|
|
666
650
|
//# sourceMappingURL=orders.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"orders.d.mts","sourceRoot":"","sources":["../../src/resources/v1/orders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,mBAAmB,CACjB,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAQ/C;;;;;;;;;;OAUG;IACH,eAAe,CACb,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAK3C;;;;;;;;OAQG;IACH,aAAa,CACX,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAKxC;;;;;;;OAOG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;OAUG;IACH,YAAY,CACV,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAKxC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED
|
|
1
|
+
{"version":3,"file":"orders.d.mts","sourceRoot":"","sources":["../../src/resources/v1/orders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,mBAAmB,CACjB,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAQ/C;;;;;;;;;;OAUG;IACH,eAAe,CACb,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAK3C;;;;;;;;OAQG;IACH,aAAa,CACX,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAKxC;;;;;;;OAOG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;OAUG;IACH,YAAY,CACV,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAKxC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC;IAE7B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAC;IAElC;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,aAAa,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAClD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,WAAW,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEhC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,WAAW,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,aAAa,GACb,KAAK,GACL,kBAAkB,GAClB,QAAQ,GACR,UAAU,GACV,UAAU,GACV,SAAS,GACT,gBAAgB,GAChB,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,SAAS,GACT,WAAW,GACX,YAAY,GACZ,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,QAAQ,GACR,OAAO,GACP,MAAM,GACN,YAAY,GACZ,eAAe,GACf,qBAAqB,GACrB,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,kBAAkB,GAAG,UAAU,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,QAAQ,GACR,OAAO,GACP,MAAM,GACN,YAAY,GACZ,eAAe,GACf,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,KAAK,GACL,kBAAkB,GAClB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,KAAK,GAAG,MAAM,GAAG,YAAY,GAAG,OAAO,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,KAAK,GACL,kBAAkB,GAClB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,GACd,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,KAAK,CAAC;AAEjD,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE;;;;;;OAMG;IACH,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,0BAA2B,SAAQ,MAAM,CAAC,YAAY;IACrE,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,yBAA0B,SAAQ,MAAM,CAAC,YAAY;IACpE;;;;;;OAMG;IACH,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,sBAAuB,SAAQ,MAAM,CAAC,YAAY;IACjE,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,yBAA0B,SAAQ,MAAM,CAAC,YAAY;IACpE;;;;;;OAMG;IACH,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,yBAA0B,SAAQ,MAAM,CAAC,YAAY;IACpE,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAE7C;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE/D;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,YAAY,GAAG,OAAO,CAAC;IAE/C;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,YAAY,GAAG,eAAe,GAAG,qBAAqB,GAAG,OAAO,CAAC;CACvG;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAE7C;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE/D;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACV,aAAa,GACb,KAAK,GACL,kBAAkB,GAClB,QAAQ,GACR,UAAU,GACV,UAAU,GACV,SAAS,GACT,gBAAgB,GAChB,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,SAAS,GACT,WAAW,GACX,YAAY,GACZ,OAAO,CACV,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACzD;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
package/resources/v1/orders.d.ts
CHANGED
|
@@ -96,22 +96,6 @@ export declare class Orders extends APIResource {
|
|
|
96
96
|
*/
|
|
97
97
|
submitOrders(accountID: number, params: OrderSubmitOrdersParams, options?: RequestOptions): APIPromise<OrderSubmitOrdersResponse>;
|
|
98
98
|
}
|
|
99
|
-
/**
|
|
100
|
-
* Request to cancel an existing order
|
|
101
|
-
*
|
|
102
|
-
* Note: In the API, order cancellation is done via DELETE request without a body.
|
|
103
|
-
* The order_id and account_id come from the URL path parameters.
|
|
104
|
-
*/
|
|
105
|
-
export interface CancelOrderRequest {
|
|
106
|
-
/**
|
|
107
|
-
* Account ID (from path parameter)
|
|
108
|
-
*/
|
|
109
|
-
account_id: number;
|
|
110
|
-
/**
|
|
111
|
-
* Order ID to cancel (from path parameter)
|
|
112
|
-
*/
|
|
113
|
-
order_id: string;
|
|
114
|
-
}
|
|
115
99
|
/**
|
|
116
100
|
* Represents a single fill of an order for an account.
|
|
117
101
|
*/
|
|
@@ -661,6 +645,6 @@ export interface OrderSubmitOrdersParams {
|
|
|
661
645
|
orders: Array<NewOrderRequest>;
|
|
662
646
|
}
|
|
663
647
|
export declare namespace Orders {
|
|
664
|
-
export { type
|
|
648
|
+
export { type Execution as Execution, type ExecutionList as ExecutionList, type InstrumentIDOrSymbol as InstrumentIDOrSymbol, type NewOrderRequest as NewOrderRequest, type Order as Order, type OrderList as OrderList, type OrderStatus as OrderStatus, type OrderType as OrderType, type QueueState as QueueState, type ReplaceOrderRequest as ReplaceOrderRequest, type RequestOrderType as RequestOrderType, type RequestTimeInForce as RequestTimeInForce, type Side as Side, type TimeInForce as TimeInForce, type TrailingOffsetType as TrailingOffsetType, type OrderCancelAllOpenOrdersResponse as OrderCancelAllOpenOrdersResponse, type OrderCancelOpenOrderResponse as OrderCancelOpenOrderResponse, type OrderGetExecutionsResponse as OrderGetExecutionsResponse, type OrderGetOrderByIDResponse as OrderGetOrderByIDResponse, type OrderGetOrdersResponse as OrderGetOrdersResponse, type OrderReplaceOrderResponse as OrderReplaceOrderResponse, type OrderSubmitOrdersResponse as OrderSubmitOrdersResponse, type OrderCancelAllOpenOrdersParams as OrderCancelAllOpenOrdersParams, type OrderCancelOpenOrderParams as OrderCancelOpenOrderParams, type OrderGetExecutionsParams as OrderGetExecutionsParams, type OrderGetOrderByIDParams as OrderGetOrderByIDParams, type OrderGetOrdersParams as OrderGetOrdersParams, type OrderReplaceOrderParams as OrderReplaceOrderParams, type OrderSubmitOrdersParams as OrderSubmitOrdersParams, };
|
|
665
649
|
}
|
|
666
650
|
//# sourceMappingURL=orders.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"orders.d.ts","sourceRoot":"","sources":["../../src/resources/v1/orders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,mBAAmB,CACjB,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAQ/C;;;;;;;;;;OAUG;IACH,eAAe,CACb,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAK3C;;;;;;;;OAQG;IACH,aAAa,CACX,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAKxC;;;;;;;OAOG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;OAUG;IACH,YAAY,CACV,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAKxC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED
|
|
1
|
+
{"version":3,"file":"orders.d.ts","sourceRoot":"","sources":["../../src/resources/v1/orders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,mBAAmB,CACjB,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAQ/C;;;;;;;;;;OAUG;IACH,eAAe,CACb,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAK3C;;;;;;;;OAQG;IACH,aAAa,CACX,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAKxC;;;;;;;OAOG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;OAUG;IACH,YAAY,CACV,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAKxC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC;IAE7B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAC;IAElC;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,aAAa,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAClD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,WAAW,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEhC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,WAAW,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,aAAa,GACb,KAAK,GACL,kBAAkB,GAClB,QAAQ,GACR,UAAU,GACV,UAAU,GACV,SAAS,GACT,gBAAgB,GAChB,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,SAAS,GACT,WAAW,GACX,YAAY,GACZ,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,QAAQ,GACR,OAAO,GACP,MAAM,GACN,YAAY,GACZ,eAAe,GACf,qBAAqB,GACrB,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,kBAAkB,GAAG,UAAU,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,QAAQ,GACR,OAAO,GACP,MAAM,GACN,YAAY,GACZ,eAAe,GACf,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,KAAK,GACL,kBAAkB,GAClB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,KAAK,GAAG,MAAM,GAAG,YAAY,GAAG,OAAO,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,KAAK,GACL,kBAAkB,GAClB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,GACd,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,KAAK,CAAC;AAEjD,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE;;;;;;OAMG;IACH,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,0BAA2B,SAAQ,MAAM,CAAC,YAAY;IACrE,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,yBAA0B,SAAQ,MAAM,CAAC,YAAY;IACpE;;;;;;OAMG;IACH,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,sBAAuB,SAAQ,MAAM,CAAC,YAAY;IACjE,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,yBAA0B,SAAQ,MAAM,CAAC,YAAY;IACpE;;;;;;OAMG;IACH,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,yBAA0B,SAAQ,MAAM,CAAC,YAAY;IACpE,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAE7C;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE/D;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,YAAY,GAAG,OAAO,CAAC;IAE/C;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,YAAY,GAAG,eAAe,GAAG,qBAAqB,GAAG,OAAO,CAAC;CACvG;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAE7C;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE/D;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACV,aAAa,GACb,KAAK,GACL,kBAAkB,GAClB,QAAQ,GACR,UAAU,GACV,UAAU,GACV,SAAS,GACT,gBAAgB,GAChB,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,SAAS,GACT,WAAW,GACX,YAAY,GACZ,OAAO,CACV,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACzD;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
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.mjs";
|
|
2
|
+
export { PrivateMarkets } from "./private-markets.mjs";
|
|
3
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/private-markets/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,2BAA2B,EAChC,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,GAChC,wBAAoB;AACrB,OAAO,EAAE,cAAc,EAAE,8BAA0B"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
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.js";
|
|
2
|
+
export { PrivateMarkets } from "./private-markets.js";
|
|
3
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/private-markets/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,2BAA2B,EAChC,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,GAChC,uBAAoB;AACrB,OAAO,EAAE,cAAc,EAAE,6BAA0B"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.PrivateMarkets = exports.Offerings = void 0;
|
|
5
|
+
var offerings_1 = require("./offerings.js");
|
|
6
|
+
Object.defineProperty(exports, "Offerings", { enumerable: true, get: function () { return offerings_1.Offerings; } });
|
|
7
|
+
var private_markets_1 = require("./private-markets.js");
|
|
8
|
+
Object.defineProperty(exports, "PrivateMarkets", { enumerable: true, get: function () { return private_markets_1.PrivateMarkets; } });
|
|
9
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/private-markets/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CAuBqB;AAtBnB,sGAAA,SAAS,OAAA;AAuBX,wDAAmD;AAA1C,iHAAA,cAAc,OAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/private-markets/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,SAAS,GAsBV,wBAAoB;AACrB,OAAO,EAAE,cAAc,EAAE,8BAA0B"}
|
|
@@ -0,0 +1,369 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
2
|
+
import * as Shared from "../../shared.mjs";
|
|
3
|
+
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
4
|
+
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.
|
|
7
|
+
*/
|
|
8
|
+
export declare class Offerings extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Fetch one visible private-market offering with its documents, participants, and
|
|
11
|
+
* any attached SPV. Requires the account holder to have attested. Returns `404`
|
|
12
|
+
* when the offering does not exist or is not currently visible.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const response =
|
|
17
|
+
* await client.v1.privateMarkets.offerings.getOfferingByID(
|
|
18
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
19
|
+
* { account_id: 0 },
|
|
20
|
+
* );
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
getOfferingByID(offeringID: string, query: OfferingGetOfferingByIDParams, options?: RequestOptions): APIPromise<OfferingGetOfferingByIDResponse>;
|
|
24
|
+
/**
|
|
25
|
+
* List every visible private-market offering as a card, with its derived class,
|
|
26
|
+
* company and SPV identity, and indicative terms. Requires the account holder to
|
|
27
|
+
* have attested.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const response =
|
|
32
|
+
* await client.v1.privateMarkets.offerings.getOfferings({
|
|
33
|
+
* account_id: 0,
|
|
34
|
+
* });
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
getOfferings(query: OfferingGetOfferingsParams, options?: RequestOptions): APIPromise<OfferingGetOfferingsResponse>;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Terms currency.
|
|
41
|
+
*/
|
|
42
|
+
export type Currency = 'USD';
|
|
43
|
+
/**
|
|
44
|
+
* Unit for a resolved highlight metric.
|
|
45
|
+
*/
|
|
46
|
+
export type MetricUnit = 'USD' | 'PERCENT' | 'COUNT' | 'RANK';
|
|
47
|
+
/**
|
|
48
|
+
* Whether a resolved highlight value is observed or estimated.
|
|
49
|
+
*/
|
|
50
|
+
export type MetricValueType = 'HISTORICAL' | 'ESTIMATED';
|
|
51
|
+
/**
|
|
52
|
+
* One offering as it appears in a list: its derived class, indicative terms, a
|
|
53
|
+
* company identity summary, and any attached SPV.
|
|
54
|
+
*/
|
|
55
|
+
export interface OfferingCard {
|
|
56
|
+
/**
|
|
57
|
+
* Stable public identifier; IOIs and history hang off it.
|
|
58
|
+
*/
|
|
59
|
+
id: string;
|
|
60
|
+
/**
|
|
61
|
+
* Derived classification.
|
|
62
|
+
*/
|
|
63
|
+
class: OfferingClass;
|
|
64
|
+
/**
|
|
65
|
+
* Owning company identity.
|
|
66
|
+
*/
|
|
67
|
+
company: OfferingCompany;
|
|
68
|
+
/**
|
|
69
|
+
* Terms currency.
|
|
70
|
+
*/
|
|
71
|
+
currency: Currency;
|
|
72
|
+
/**
|
|
73
|
+
* Card/detail headline.
|
|
74
|
+
*/
|
|
75
|
+
headline: string;
|
|
76
|
+
/**
|
|
77
|
+
* Top opportunity paragraph.
|
|
78
|
+
*/
|
|
79
|
+
summary: string;
|
|
80
|
+
/**
|
|
81
|
+
* Indicative price-per-share range, high endpoint.
|
|
82
|
+
*/
|
|
83
|
+
indicative_price_high?: string | null;
|
|
84
|
+
/**
|
|
85
|
+
* Indicative price-per-share range, low endpoint.
|
|
86
|
+
*/
|
|
87
|
+
indicative_price_low?: string | null;
|
|
88
|
+
/**
|
|
89
|
+
* Meaning of the indicative valuation range.
|
|
90
|
+
*/
|
|
91
|
+
indicative_valuation_basis?: ValuationBasis | null;
|
|
92
|
+
/**
|
|
93
|
+
* Indicative valuation range, high endpoint.
|
|
94
|
+
*/
|
|
95
|
+
indicative_valuation_high?: string | null;
|
|
96
|
+
/**
|
|
97
|
+
* Indicative valuation range, low endpoint.
|
|
98
|
+
*/
|
|
99
|
+
indicative_valuation_low?: string | null;
|
|
100
|
+
/**
|
|
101
|
+
* Deadline for indications of interest.
|
|
102
|
+
*/
|
|
103
|
+
ioi_deadline?: string | null;
|
|
104
|
+
/**
|
|
105
|
+
* Minimum indication-of-interest amount.
|
|
106
|
+
*/
|
|
107
|
+
minimum_ioi_amount?: string | null;
|
|
108
|
+
/**
|
|
109
|
+
* Attached SPV identity and lifecycle, once one exists.
|
|
110
|
+
*/
|
|
111
|
+
spv?: OfferingSpv | null;
|
|
112
|
+
}
|
|
113
|
+
export type OfferingCardList = Array<OfferingCard>;
|
|
114
|
+
/**
|
|
115
|
+
* Derived offering classification.
|
|
116
|
+
*/
|
|
117
|
+
export type OfferingClass = 'UPCOMING' | 'ACTIVE';
|
|
118
|
+
/**
|
|
119
|
+
* Company identity carried on an offering card/detail.
|
|
120
|
+
*/
|
|
121
|
+
export interface OfferingCompany {
|
|
122
|
+
/**
|
|
123
|
+
* Stable company identifier.
|
|
124
|
+
*/
|
|
125
|
+
id: string;
|
|
126
|
+
/**
|
|
127
|
+
* Display name.
|
|
128
|
+
*/
|
|
129
|
+
name: string;
|
|
130
|
+
/**
|
|
131
|
+
* Short card/search description.
|
|
132
|
+
*/
|
|
133
|
+
short_description: string;
|
|
134
|
+
/**
|
|
135
|
+
* Lowercase URL slug.
|
|
136
|
+
*/
|
|
137
|
+
slug: string;
|
|
138
|
+
/**
|
|
139
|
+
* Company logo URL, when known.
|
|
140
|
+
*/
|
|
141
|
+
logo_url?: string | null;
|
|
142
|
+
/**
|
|
143
|
+
* Canonical lowercase domain, when known.
|
|
144
|
+
*/
|
|
145
|
+
primary_domain?: string | null;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* One offering with everything needed to render its detail payload.
|
|
149
|
+
*/
|
|
150
|
+
export interface OfferingDetail extends OfferingCard {
|
|
151
|
+
/**
|
|
152
|
+
* Important disclosures.
|
|
153
|
+
*/
|
|
154
|
+
disclosures?: string | null;
|
|
155
|
+
/**
|
|
156
|
+
* Campaign documents in display order.
|
|
157
|
+
*/
|
|
158
|
+
documents?: Array<OfferingDocumentResource>;
|
|
159
|
+
/**
|
|
160
|
+
* Ordered resolved highlights.
|
|
161
|
+
*/
|
|
162
|
+
highlights?: Array<OfferingHighlight>;
|
|
163
|
+
/**
|
|
164
|
+
* Campaign-specific investment framing.
|
|
165
|
+
*/
|
|
166
|
+
investment_thesis?: string | null;
|
|
167
|
+
/**
|
|
168
|
+
* Ordered key risks.
|
|
169
|
+
*/
|
|
170
|
+
key_risks?: Array<OfferingKeyRisk>;
|
|
171
|
+
/**
|
|
172
|
+
* Campaign participants in display order.
|
|
173
|
+
*/
|
|
174
|
+
participants?: Array<OfferingParticipantResource>;
|
|
175
|
+
/**
|
|
176
|
+
* Vehicle/structure framing shown before typed SPV terms exist.
|
|
177
|
+
*/
|
|
178
|
+
structure_description?: string | null;
|
|
179
|
+
/**
|
|
180
|
+
* Why-now framing.
|
|
181
|
+
*/
|
|
182
|
+
why_now?: string | null;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* A campaign document's display metadata. Exactly one of `url`/`object_key` is
|
|
186
|
+
* set; an object key is resolved and signed elsewhere.
|
|
187
|
+
*/
|
|
188
|
+
export interface OfferingDocumentResource {
|
|
189
|
+
/**
|
|
190
|
+
* Stable identifier.
|
|
191
|
+
*/
|
|
192
|
+
id: string;
|
|
193
|
+
/**
|
|
194
|
+
* Stable display position.
|
|
195
|
+
*/
|
|
196
|
+
display_order: number;
|
|
197
|
+
/**
|
|
198
|
+
* Document kind.
|
|
199
|
+
*/
|
|
200
|
+
document_type: OfferingDocumentType;
|
|
201
|
+
/**
|
|
202
|
+
* Display title.
|
|
203
|
+
*/
|
|
204
|
+
title: string;
|
|
205
|
+
/**
|
|
206
|
+
* Object-store key, when the document is stored internally.
|
|
207
|
+
*/
|
|
208
|
+
object_key?: string | null;
|
|
209
|
+
/**
|
|
210
|
+
* Publication time, when known.
|
|
211
|
+
*/
|
|
212
|
+
published_at?: string | null;
|
|
213
|
+
/**
|
|
214
|
+
* Source publisher/provider.
|
|
215
|
+
*/
|
|
216
|
+
source?: string | null;
|
|
217
|
+
/**
|
|
218
|
+
* Source URL.
|
|
219
|
+
*/
|
|
220
|
+
source_url?: string | null;
|
|
221
|
+
/**
|
|
222
|
+
* Externally reachable URL, when the document lives at one.
|
|
223
|
+
*/
|
|
224
|
+
url?: string | null;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* Kind of campaign document.
|
|
228
|
+
*/
|
|
229
|
+
export type OfferingDocumentType = 'TEARSHEET' | 'KEY_TERMS' | 'RISK_FACTORS' | 'PPM' | 'OTHER';
|
|
230
|
+
/**
|
|
231
|
+
* A curated highlight, resolved against the company profile's metric series.
|
|
232
|
+
*/
|
|
233
|
+
export interface OfferingHighlight {
|
|
234
|
+
/**
|
|
235
|
+
* Display label (the highlight's override, else the series' own label).
|
|
236
|
+
*/
|
|
237
|
+
label: string;
|
|
238
|
+
/**
|
|
239
|
+
* Canonical metric key selected by the highlight (e.g. `REVENUE_GROWTH`).
|
|
240
|
+
*/
|
|
241
|
+
metric_key: string;
|
|
242
|
+
/**
|
|
243
|
+
* Value unit.
|
|
244
|
+
*/
|
|
245
|
+
unit: MetricUnit;
|
|
246
|
+
/**
|
|
247
|
+
* Observation time of the latest value.
|
|
248
|
+
*/
|
|
249
|
+
observed_at?: string | null;
|
|
250
|
+
/**
|
|
251
|
+
* Latest observed value, when the series carries any points.
|
|
252
|
+
*/
|
|
253
|
+
value?: string | null;
|
|
254
|
+
/**
|
|
255
|
+
* Whether the latest value is historical or estimated.
|
|
256
|
+
*/
|
|
257
|
+
value_type?: MetricValueType | null;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* One ordered key-risk block.
|
|
261
|
+
*/
|
|
262
|
+
export interface OfferingKeyRisk {
|
|
263
|
+
/**
|
|
264
|
+
* Plain-text risk body.
|
|
265
|
+
*/
|
|
266
|
+
body: string;
|
|
267
|
+
/**
|
|
268
|
+
* Risk heading.
|
|
269
|
+
*/
|
|
270
|
+
title: string;
|
|
271
|
+
/**
|
|
272
|
+
* Profile-local citation ids supporting the risk.
|
|
273
|
+
*/
|
|
274
|
+
citation_ids?: Array<string>;
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* An offering participant's display data.
|
|
278
|
+
*/
|
|
279
|
+
export interface OfferingParticipantResource {
|
|
280
|
+
/**
|
|
281
|
+
* Stable identifier.
|
|
282
|
+
*/
|
|
283
|
+
id: string;
|
|
284
|
+
/**
|
|
285
|
+
* Stable display position.
|
|
286
|
+
*/
|
|
287
|
+
display_order: number;
|
|
288
|
+
/**
|
|
289
|
+
* Display name.
|
|
290
|
+
*/
|
|
291
|
+
name: string;
|
|
292
|
+
/**
|
|
293
|
+
* Presentation role.
|
|
294
|
+
*/
|
|
295
|
+
role: ParticipantRole;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* The attached SPV's identity and lifecycle. Exact economics surface once the SPV
|
|
299
|
+
* opens; an upcoming offering's indicative ranges describe the terms until then.
|
|
300
|
+
*/
|
|
301
|
+
export interface OfferingSpv {
|
|
302
|
+
/**
|
|
303
|
+
* Stable SPV identifier.
|
|
304
|
+
*/
|
|
305
|
+
id: string;
|
|
306
|
+
/**
|
|
307
|
+
* Legal/display name.
|
|
308
|
+
*/
|
|
309
|
+
name: string;
|
|
310
|
+
/**
|
|
311
|
+
* Lifecycle state.
|
|
312
|
+
*/
|
|
313
|
+
status: SpvStatus;
|
|
314
|
+
/**
|
|
315
|
+
* Custodian.
|
|
316
|
+
*/
|
|
317
|
+
custodian_name?: string | null;
|
|
318
|
+
/**
|
|
319
|
+
* SPV manager.
|
|
320
|
+
*/
|
|
321
|
+
manager_name?: string | null;
|
|
322
|
+
/**
|
|
323
|
+
* Underlying share class, when specified.
|
|
324
|
+
*/
|
|
325
|
+
share_class?: string | null;
|
|
326
|
+
/**
|
|
327
|
+
* Plain-text vehicle structure.
|
|
328
|
+
*/
|
|
329
|
+
structure_description?: string | null;
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* Presentation role of an offering participant.
|
|
333
|
+
*/
|
|
334
|
+
export type ParticipantRole = 'LEAD_INVESTOR' | 'CO_LEAD' | 'FUND_MANAGER' | 'PLACEMENT_AGENT';
|
|
335
|
+
/**
|
|
336
|
+
* SPV lifecycle state.
|
|
337
|
+
*/
|
|
338
|
+
export type SpvStatus = 'DRAFT' | 'OPEN' | 'CLOSED' | 'LIQUIDATING' | 'DISSOLVED';
|
|
339
|
+
/**
|
|
340
|
+
* Meaning of an indicative valuation range or an SPV valuation.
|
|
341
|
+
*/
|
|
342
|
+
export type ValuationBasis = 'PRE_MONEY' | 'POST_MONEY' | 'REFERENCE' | 'IMPLIED';
|
|
343
|
+
export interface OfferingGetOfferingByIDResponse extends Shared.BaseResponse {
|
|
344
|
+
/**
|
|
345
|
+
* One offering with everything needed to render its detail payload.
|
|
346
|
+
*/
|
|
347
|
+
data: OfferingDetail;
|
|
348
|
+
}
|
|
349
|
+
export interface OfferingGetOfferingsResponse extends Shared.BaseResponse {
|
|
350
|
+
data: OfferingCardList;
|
|
351
|
+
}
|
|
352
|
+
export interface OfferingGetOfferingByIDParams {
|
|
353
|
+
/**
|
|
354
|
+
* Account whose account-holder entity must hold an accreditation attestation to
|
|
355
|
+
* browse private-market offerings.
|
|
356
|
+
*/
|
|
357
|
+
account_id: number;
|
|
358
|
+
}
|
|
359
|
+
export interface OfferingGetOfferingsParams {
|
|
360
|
+
/**
|
|
361
|
+
* Account whose account-holder entity must hold an accreditation attestation to
|
|
362
|
+
* browse private-market offerings.
|
|
363
|
+
*/
|
|
364
|
+
account_id: number;
|
|
365
|
+
}
|
|
366
|
+
export declare namespace Offerings {
|
|
367
|
+
export { type Currency as Currency, type MetricUnit as MetricUnit, type MetricValueType as MetricValueType, type OfferingCard as OfferingCard, type OfferingCardList as OfferingCardList, type OfferingClass as OfferingClass, type OfferingCompany as OfferingCompany, type OfferingDetail as OfferingDetail, type OfferingDocumentResource as OfferingDocumentResource, type OfferingDocumentType as OfferingDocumentType, type OfferingHighlight as OfferingHighlight, type OfferingKeyRisk as OfferingKeyRisk, type OfferingParticipantResource as OfferingParticipantResource, type OfferingSpv as OfferingSpv, type ParticipantRole as ParticipantRole, type SpvStatus as SpvStatus, type ValuationBasis as ValuationBasis, type OfferingGetOfferingByIDResponse as OfferingGetOfferingByIDResponse, type OfferingGetOfferingsResponse as OfferingGetOfferingsResponse, type OfferingGetOfferingByIDParams as OfferingGetOfferingByIDParams, type OfferingGetOfferingsParams as OfferingGetOfferingsParams, };
|
|
368
|
+
}
|
|
369
|
+
//# sourceMappingURL=offerings.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"offerings.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/private-markets/offerings.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,MAAM,yBAAqB;AACvC,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;OAaG;IACH,eAAe,CACb,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,YAAY,GAAG,WAAW,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,0BAA0B,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,GAAG,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAE5C;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEtC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEnC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAElD;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,oBAAoB,CAAC;IAEpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,GAAG,KAAK,GAAG,OAAO,CAAC;AAEhG;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG,SAAS,GAAG,cAAc,GAAG,iBAAiB,CAAC;AAE/F;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,aAAa,GAAG,WAAW,CAAC;AAElF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,SAAS,CAAC;AAElF,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
|