@clear-street/clearstreet 0.94.0 → 0.96.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.
Files changed (106) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/package.json +1 -1
  3. package/resources/v1/accounts.d.mts +27 -14
  4. package/resources/v1/accounts.d.mts.map +1 -1
  5. package/resources/v1/accounts.d.ts +27 -14
  6. package/resources/v1/accounts.d.ts.map +1 -1
  7. package/resources/v1/index.d.mts +4 -3
  8. package/resources/v1/index.d.mts.map +1 -1
  9. package/resources/v1/index.d.ts +4 -3
  10. package/resources/v1/index.d.ts.map +1 -1
  11. package/resources/v1/index.js +3 -1
  12. package/resources/v1/index.js.map +1 -1
  13. package/resources/v1/index.mjs +1 -0
  14. package/resources/v1/index.mjs.map +1 -1
  15. package/resources/v1/instrument-data/market-data.d.mts +40 -1
  16. package/resources/v1/instrument-data/market-data.d.mts.map +1 -1
  17. package/resources/v1/instrument-data/market-data.d.ts +40 -1
  18. package/resources/v1/instrument-data/market-data.d.ts.map +1 -1
  19. package/resources/v1/omni-ai/index.d.mts +1 -1
  20. package/resources/v1/omni-ai/index.d.mts.map +1 -1
  21. package/resources/v1/omni-ai/index.d.ts +1 -1
  22. package/resources/v1/omni-ai/index.d.ts.map +1 -1
  23. package/resources/v1/omni-ai/index.js.map +1 -1
  24. package/resources/v1/omni-ai/index.mjs.map +1 -1
  25. package/resources/v1/omni-ai/omni-ai.d.mts +162 -3
  26. package/resources/v1/omni-ai/omni-ai.d.mts.map +1 -1
  27. package/resources/v1/omni-ai/omni-ai.d.ts +162 -3
  28. package/resources/v1/omni-ai/omni-ai.d.ts.map +1 -1
  29. package/resources/v1/omni-ai/omni-ai.js.map +1 -1
  30. package/resources/v1/omni-ai/omni-ai.mjs.map +1 -1
  31. package/resources/v1/orders.d.mts +19 -25
  32. package/resources/v1/orders.d.mts.map +1 -1
  33. package/resources/v1/orders.d.ts +19 -25
  34. package/resources/v1/orders.d.ts.map +1 -1
  35. package/resources/v1/positions.d.mts +18 -7
  36. package/resources/v1/positions.d.mts.map +1 -1
  37. package/resources/v1/positions.d.ts +18 -7
  38. package/resources/v1/positions.d.ts.map +1 -1
  39. package/resources/v1/positions.js +2 -2
  40. package/resources/v1/positions.mjs +2 -2
  41. package/resources/v1/private-markets/index.d.mts +3 -0
  42. package/resources/v1/private-markets/index.d.mts.map +1 -0
  43. package/resources/v1/private-markets/index.d.ts +3 -0
  44. package/resources/v1/private-markets/index.d.ts.map +1 -0
  45. package/resources/v1/private-markets/index.js +9 -0
  46. package/resources/v1/private-markets/index.js.map +1 -0
  47. package/resources/v1/private-markets/index.mjs +4 -0
  48. package/resources/v1/private-markets/index.mjs.map +1 -0
  49. package/resources/v1/private-markets/offerings.d.mts +369 -0
  50. package/resources/v1/private-markets/offerings.d.mts.map +1 -0
  51. package/resources/v1/private-markets/offerings.d.ts +369 -0
  52. package/resources/v1/private-markets/offerings.d.ts.map +1 -0
  53. package/resources/v1/private-markets/offerings.js +46 -0
  54. package/resources/v1/private-markets/offerings.js.map +1 -0
  55. package/resources/v1/private-markets/offerings.mjs +42 -0
  56. package/resources/v1/private-markets/offerings.mjs.map +1 -0
  57. package/resources/v1/private-markets/private-markets.d.mts +10 -0
  58. package/resources/v1/private-markets/private-markets.d.mts.map +1 -0
  59. package/resources/v1/private-markets/private-markets.d.ts +10 -0
  60. package/resources/v1/private-markets/private-markets.d.ts.map +1 -0
  61. package/resources/v1/private-markets/private-markets.js +17 -0
  62. package/resources/v1/private-markets/private-markets.js.map +1 -0
  63. package/resources/v1/private-markets/private-markets.mjs +12 -0
  64. package/resources/v1/private-markets/private-markets.mjs.map +1 -0
  65. package/resources/v1/private-markets.d.mts +2 -0
  66. package/resources/v1/private-markets.d.mts.map +1 -0
  67. package/resources/v1/private-markets.d.ts +2 -0
  68. package/resources/v1/private-markets.d.ts.map +1 -0
  69. package/resources/v1/private-markets.js +6 -0
  70. package/resources/v1/private-markets.js.map +1 -0
  71. package/resources/v1/private-markets.mjs +3 -0
  72. package/resources/v1/private-markets.mjs.map +1 -0
  73. package/resources/v1/screener.d.mts +308 -6
  74. package/resources/v1/screener.d.mts.map +1 -1
  75. package/resources/v1/screener.d.ts +308 -6
  76. package/resources/v1/screener.d.ts.map +1 -1
  77. package/resources/v1/screener.js +32 -5
  78. package/resources/v1/screener.js.map +1 -1
  79. package/resources/v1/screener.mjs +32 -5
  80. package/resources/v1/screener.mjs.map +1 -1
  81. package/resources/v1/v1.d.mts +10 -6
  82. package/resources/v1/v1.d.mts.map +1 -1
  83. package/resources/v1/v1.d.ts +10 -6
  84. package/resources/v1/v1.d.ts.map +1 -1
  85. package/resources/v1/v1.js +4 -0
  86. package/resources/v1/v1.js.map +1 -1
  87. package/resources/v1/v1.mjs +4 -0
  88. package/resources/v1/v1.mjs.map +1 -1
  89. package/src/resources/v1/accounts.ts +27 -14
  90. package/src/resources/v1/index.ts +14 -1
  91. package/src/resources/v1/instrument-data/market-data.ts +46 -1
  92. package/src/resources/v1/omni-ai/index.ts +2 -0
  93. package/src/resources/v1/omni-ai/omni-ai.ts +193 -2
  94. package/src/resources/v1/orders.ts +21 -27
  95. package/src/resources/v1/positions.ts +20 -7
  96. package/src/resources/v1/private-markets/index.ts +27 -0
  97. package/src/resources/v1/private-markets/offerings.ts +477 -0
  98. package/src/resources/v1/private-markets/private-markets.ts +61 -0
  99. package/src/resources/v1/private-markets.ts +3 -0
  100. package/src/resources/v1/screener.ts +367 -5
  101. package/src/resources/v1/v1.ts +32 -2
  102. package/src/version.ts +1 -1
  103. package/version.d.mts +1 -1
  104. package/version.d.ts +1 -1
  105. package/version.js +1 -1
  106. package/version.mjs +1 -1
@@ -92,8 +92,8 @@ export declare class Positions extends APIResource {
92
92
  * cause: `409` when every row was a duplicate, `400` for validation failures
93
93
  * like DNE/CEA on a non-expiry day, `503` if the clearing service is
94
94
  * unavailable. `data` still contains every row carrying `status = REJECTED` and
95
- * `rejection_reason` so callers can attribute failures by `instruction_id`; the
96
- * top-level `error` summarizes the batch.
95
+ * `rejection_reason` so callers can attribute failures by
96
+ * `client_instruction_id`; the top-level `error` summarizes the batch.
97
97
  *
98
98
  * @example
99
99
  * ```ts
@@ -224,7 +224,7 @@ export interface PositionInstruction {
224
224
  * Caller-supplied idempotency key echoed from the submit request; the
225
225
  * server-assigned fallback when none was supplied.
226
226
  */
227
- instruction_id: string;
227
+ client_instruction_id: string;
228
228
  /**
229
229
  * The action this instruction requests.
230
230
  */
@@ -263,6 +263,11 @@ export interface PositionInstruction {
263
263
  * here. When a null/undefined value is observed, it indicates it does not apply.
264
264
  */
265
265
  rejection_reason?: string | null;
266
+ /**
267
+ * Identifier of the underlying instrument, when available. When a null/undefined
268
+ * value is observed, it indicates it does not apply.
269
+ */
270
+ underlying_instrument_id?: string | null;
266
271
  /**
267
272
  * When the instruction's lifecycle state last changed. When a null/undefined value
268
273
  * is observed, it indicates that there is no available data.
@@ -277,9 +282,9 @@ export type PositionInstructionList = Array<PositionInstruction>;
277
282
  * - `ACCEPTED`: terminal — accepted by the clearing venue.
278
283
  * - `REJECTED`: terminal rejection; `rejection_reason` carries the detail. Covers
279
284
  * both venue-reported rejections and rejections raised before the instruction
280
- * reached the clearing venue (e.g. duplicate `instruction_id`, `DO_NOT_EXERCISE`
281
- * / `CONTRARY_EXERCISE` submitted on a non-expiry day, insufficient position, or
282
- * an instrument that does not resolve).
285
+ * reached the clearing venue (e.g. duplicate `client_instruction_id`,
286
+ * `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` submitted on a non-expiry day,
287
+ * insufficient position, or an instrument that does not resolve).
283
288
  * - `CANCEL_REQUESTED`: cancel accepted; final cancel state pending.
284
289
  * - `CANCELLED`: terminal — cancel completed.
285
290
  * - `CANCEL_FAILED`: cancel could not be completed; operator attention required.
@@ -347,6 +352,12 @@ export interface PositionGetPositionInstructionsParams {
347
352
  * ticker or OSI option symbol).
348
353
  */
349
354
  instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
355
+ /**
356
+ * Limit results to instructions whose contract has this underlier. Instrument ID
357
+ * (UUID) or symbol (equity ticker or OSI option symbol). Combined with
358
+ * `instrument_id` as a logical AND when both are supplied.
359
+ */
360
+ underlying_instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
350
361
  }
351
362
  export interface PositionGetPositionsParams {
352
363
  /**
@@ -399,7 +410,7 @@ export declare namespace PositionSubmitPositionInstructionsParams {
399
410
  * Caller-supplied idempotency key. Echoed on the response. The server generates a
400
411
  * unique id when omitted.
401
412
  */
402
- instruction_id?: string | null;
413
+ client_instruction_id?: string | null;
403
414
  }
404
415
  }
405
416
  export declare namespace Positions {
@@ -1 +1 @@
1
- {"version":3,"file":"positions.d.mts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;CAO1D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,yCAA0C,SAAQ,MAAM,CAAC,YAAY;IACpF;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,0CAA2C,SAAQ,MAAM,CAAC,YAAY;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAChD;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,oBAAoB,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,wCAAwC;IACvD,YAAY,EAAE,KAAK,CAAC,wCAAwC,CAAC,WAAW,CAAC,CAAC;CAC3E;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;;;;OAKG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,uBAAuB,CAAC;QAEvD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAChC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
1
+ {"version":3,"file":"positions.d.mts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;CAO1D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,yCAA0C,SAAQ,MAAM,CAAC,YAAY;IACpF;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,0CAA2C,SAAQ,MAAM,CAAC,YAAY;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE/C;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC3D;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,oBAAoB,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,wCAAwC;IACvD,YAAY,EAAE,KAAK,CAAC,wCAAwC,CAAC,WAAW,CAAC,CAAC;CAC3E;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;;;;OAKG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,uBAAuB,CAAC;QAEvD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
@@ -92,8 +92,8 @@ export declare class Positions extends APIResource {
92
92
  * cause: `409` when every row was a duplicate, `400` for validation failures
93
93
  * like DNE/CEA on a non-expiry day, `503` if the clearing service is
94
94
  * unavailable. `data` still contains every row carrying `status = REJECTED` and
95
- * `rejection_reason` so callers can attribute failures by `instruction_id`; the
96
- * top-level `error` summarizes the batch.
95
+ * `rejection_reason` so callers can attribute failures by
96
+ * `client_instruction_id`; the top-level `error` summarizes the batch.
97
97
  *
98
98
  * @example
99
99
  * ```ts
@@ -224,7 +224,7 @@ export interface PositionInstruction {
224
224
  * Caller-supplied idempotency key echoed from the submit request; the
225
225
  * server-assigned fallback when none was supplied.
226
226
  */
227
- instruction_id: string;
227
+ client_instruction_id: string;
228
228
  /**
229
229
  * The action this instruction requests.
230
230
  */
@@ -263,6 +263,11 @@ export interface PositionInstruction {
263
263
  * here. When a null/undefined value is observed, it indicates it does not apply.
264
264
  */
265
265
  rejection_reason?: string | null;
266
+ /**
267
+ * Identifier of the underlying instrument, when available. When a null/undefined
268
+ * value is observed, it indicates it does not apply.
269
+ */
270
+ underlying_instrument_id?: string | null;
266
271
  /**
267
272
  * When the instruction's lifecycle state last changed. When a null/undefined value
268
273
  * is observed, it indicates that there is no available data.
@@ -277,9 +282,9 @@ export type PositionInstructionList = Array<PositionInstruction>;
277
282
  * - `ACCEPTED`: terminal — accepted by the clearing venue.
278
283
  * - `REJECTED`: terminal rejection; `rejection_reason` carries the detail. Covers
279
284
  * both venue-reported rejections and rejections raised before the instruction
280
- * reached the clearing venue (e.g. duplicate `instruction_id`, `DO_NOT_EXERCISE`
281
- * / `CONTRARY_EXERCISE` submitted on a non-expiry day, insufficient position, or
282
- * an instrument that does not resolve).
285
+ * reached the clearing venue (e.g. duplicate `client_instruction_id`,
286
+ * `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` submitted on a non-expiry day,
287
+ * insufficient position, or an instrument that does not resolve).
283
288
  * - `CANCEL_REQUESTED`: cancel accepted; final cancel state pending.
284
289
  * - `CANCELLED`: terminal — cancel completed.
285
290
  * - `CANCEL_FAILED`: cancel could not be completed; operator attention required.
@@ -347,6 +352,12 @@ export interface PositionGetPositionInstructionsParams {
347
352
  * ticker or OSI option symbol).
348
353
  */
349
354
  instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
355
+ /**
356
+ * Limit results to instructions whose contract has this underlier. Instrument ID
357
+ * (UUID) or symbol (equity ticker or OSI option symbol). Combined with
358
+ * `instrument_id` as a logical AND when both are supplied.
359
+ */
360
+ underlying_instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
350
361
  }
351
362
  export interface PositionGetPositionsParams {
352
363
  /**
@@ -399,7 +410,7 @@ export declare namespace PositionSubmitPositionInstructionsParams {
399
410
  * Caller-supplied idempotency key. Echoed on the response. The server generates a
400
411
  * unique id when omitted.
401
412
  */
402
- instruction_id?: string | null;
413
+ client_instruction_id?: string | null;
403
414
  }
404
415
  }
405
416
  export declare namespace Positions {
@@ -1 +1 @@
1
- {"version":3,"file":"positions.d.ts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,YAAY,uBAAoB;AAC5C,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;CAO1D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,yCAA0C,SAAQ,MAAM,CAAC,YAAY;IACpF;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,0CAA2C,SAAQ,MAAM,CAAC,YAAY;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAChD;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,oBAAoB,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,wCAAwC;IACvD,YAAY,EAAE,KAAK,CAAC,wCAAwC,CAAC,WAAW,CAAC,CAAC;CAC3E;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;;;;OAKG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,uBAAuB,CAAC;QAEvD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAChC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
1
+ {"version":3,"file":"positions.d.ts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,YAAY,uBAAoB;AAC5C,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;CAO1D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,yCAA0C,SAAQ,MAAM,CAAC,YAAY;IACpF;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,0CAA2C,SAAQ,MAAM,CAAC,YAAY;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE/C;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC3D;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,oBAAoB,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,wCAAwC;IACvD,YAAY,EAAE,KAAK,CAAC,wCAAwC,CAAC,WAAW,CAAC,CAAC;CAC3E;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;;;;OAKG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,uBAAuB,CAAC;QAEvD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
@@ -106,8 +106,8 @@ class Positions extends resource_1.APIResource {
106
106
  * cause: `409` when every row was a duplicate, `400` for validation failures
107
107
  * like DNE/CEA on a non-expiry day, `503` if the clearing service is
108
108
  * unavailable. `data` still contains every row carrying `status = REJECTED` and
109
- * `rejection_reason` so callers can attribute failures by `instruction_id`; the
110
- * top-level `error` summarizes the batch.
109
+ * `rejection_reason` so callers can attribute failures by
110
+ * `client_instruction_id`; the top-level `error` summarizes the batch.
111
111
  *
112
112
  * @example
113
113
  * ```ts
@@ -103,8 +103,8 @@ export class Positions extends APIResource {
103
103
  * cause: `409` when every row was a duplicate, `400` for validation failures
104
104
  * like DNE/CEA on a non-expiry day, `503` if the clearing service is
105
105
  * unavailable. `data` still contains every row carrying `status = REJECTED` and
106
- * `rejection_reason` so callers can attribute failures by `instruction_id`; the
107
- * top-level `error` summarizes the batch.
106
+ * `rejection_reason` so callers can attribute failures by
107
+ * `client_instruction_id`; the top-level `error` summarizes the batch.
108
108
  *
109
109
  * @example
110
110
  * ```ts
@@ -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,4 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ export { Offerings, } from "./offerings.mjs";
3
+ export { PrivateMarkets } from "./private-markets.mjs";
4
+ //# sourceMappingURL=index.mjs.map
@@ -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"}