@clear-street/clearstreet 0.103.0 → 0.105.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 (130) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/client.d.mts +0 -1
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +0 -1
  5. package/client.d.ts.map +1 -1
  6. package/package.json +1 -1
  7. package/resources/shared.d.mts +3 -4
  8. package/resources/shared.d.mts.map +1 -1
  9. package/resources/shared.d.ts +3 -4
  10. package/resources/shared.d.ts.map +1 -1
  11. package/resources/v1/accounts.d.mts +15 -3
  12. package/resources/v1/accounts.d.mts.map +1 -1
  13. package/resources/v1/accounts.d.ts +15 -3
  14. package/resources/v1/accounts.d.ts.map +1 -1
  15. package/resources/v1/index.d.mts +2 -2
  16. package/resources/v1/index.d.mts.map +1 -1
  17. package/resources/v1/index.d.ts +2 -2
  18. package/resources/v1/index.d.ts.map +1 -1
  19. package/resources/v1/index.js.map +1 -1
  20. package/resources/v1/index.mjs.map +1 -1
  21. package/resources/v1/instrument-data/market-data.d.mts +2 -1
  22. package/resources/v1/instrument-data/market-data.d.mts.map +1 -1
  23. package/resources/v1/instrument-data/market-data.d.ts +2 -1
  24. package/resources/v1/instrument-data/market-data.d.ts.map +1 -1
  25. package/resources/v1/instruments.d.mts +9 -4
  26. package/resources/v1/instruments.d.mts.map +1 -1
  27. package/resources/v1/instruments.d.ts +9 -4
  28. package/resources/v1/instruments.d.ts.map +1 -1
  29. package/resources/v1/instruments.js +2 -2
  30. package/resources/v1/instruments.mjs +2 -2
  31. package/resources/v1/locates.d.mts +123 -1
  32. package/resources/v1/locates.d.mts.map +1 -1
  33. package/resources/v1/locates.d.ts +123 -1
  34. package/resources/v1/locates.d.ts.map +1 -1
  35. package/resources/v1/locates.js +33 -0
  36. package/resources/v1/locates.js.map +1 -1
  37. package/resources/v1/locates.mjs +33 -0
  38. package/resources/v1/locates.mjs.map +1 -1
  39. package/resources/v1/omni-ai/entitlements.d.mts +58 -10
  40. package/resources/v1/omni-ai/entitlements.d.mts.map +1 -1
  41. package/resources/v1/omni-ai/entitlements.d.ts +58 -10
  42. package/resources/v1/omni-ai/entitlements.d.ts.map +1 -1
  43. package/resources/v1/omni-ai/entitlements.js +35 -9
  44. package/resources/v1/omni-ai/entitlements.js.map +1 -1
  45. package/resources/v1/omni-ai/entitlements.mjs +35 -9
  46. package/resources/v1/omni-ai/entitlements.mjs.map +1 -1
  47. package/resources/v1/omni-ai/index.d.mts +1 -1
  48. package/resources/v1/omni-ai/index.d.mts.map +1 -1
  49. package/resources/v1/omni-ai/index.d.ts +1 -1
  50. package/resources/v1/omni-ai/index.d.ts.map +1 -1
  51. package/resources/v1/omni-ai/index.js.map +1 -1
  52. package/resources/v1/omni-ai/index.mjs.map +1 -1
  53. package/resources/v1/omni-ai/omni-ai.d.mts +4 -3
  54. package/resources/v1/omni-ai/omni-ai.d.mts.map +1 -1
  55. package/resources/v1/omni-ai/omni-ai.d.ts +4 -3
  56. package/resources/v1/omni-ai/omni-ai.d.ts.map +1 -1
  57. package/resources/v1/omni-ai/omni-ai.js.map +1 -1
  58. package/resources/v1/omni-ai/omni-ai.mjs.map +1 -1
  59. package/resources/v1/orders.d.mts +2 -1
  60. package/resources/v1/orders.d.mts.map +1 -1
  61. package/resources/v1/orders.d.ts +2 -1
  62. package/resources/v1/orders.d.ts.map +1 -1
  63. package/resources/v1/private-markets/index.d.mts +2 -4
  64. package/resources/v1/private-markets/index.d.mts.map +1 -1
  65. package/resources/v1/private-markets/index.d.ts +2 -4
  66. package/resources/v1/private-markets/index.d.ts.map +1 -1
  67. package/resources/v1/private-markets/index.js +1 -5
  68. package/resources/v1/private-markets/index.js.map +1 -1
  69. package/resources/v1/private-markets/index.mjs +0 -2
  70. package/resources/v1/private-markets/index.mjs.map +1 -1
  71. package/resources/v1/private-markets/iois.d.mts +151 -1
  72. package/resources/v1/private-markets/iois.d.mts.map +1 -1
  73. package/resources/v1/private-markets/iois.d.ts +151 -1
  74. package/resources/v1/private-markets/iois.d.ts.map +1 -1
  75. package/resources/v1/private-markets/iois.js +75 -0
  76. package/resources/v1/private-markets/iois.js.map +1 -1
  77. package/resources/v1/private-markets/iois.mjs +75 -0
  78. package/resources/v1/private-markets/iois.mjs.map +1 -1
  79. package/resources/v1/private-markets/private-markets.d.mts +494 -133
  80. package/resources/v1/private-markets/private-markets.d.mts.map +1 -1
  81. package/resources/v1/private-markets/private-markets.d.ts +494 -133
  82. package/resources/v1/private-markets/private-markets.d.ts.map +1 -1
  83. package/resources/v1/private-markets/private-markets.js +0 -76
  84. package/resources/v1/private-markets/private-markets.js.map +1 -1
  85. package/resources/v1/private-markets/private-markets.mjs +0 -76
  86. package/resources/v1/private-markets/private-markets.mjs.map +1 -1
  87. package/resources/v1/v1.d.mts +4 -4
  88. package/resources/v1/v1.d.mts.map +1 -1
  89. package/resources/v1/v1.d.ts +4 -4
  90. package/resources/v1/v1.d.ts.map +1 -1
  91. package/resources/v1/v1.js.map +1 -1
  92. package/resources/v1/v1.mjs.map +1 -1
  93. package/src/client.ts +0 -1
  94. package/src/resources/shared.ts +1 -3
  95. package/src/resources/v1/accounts.ts +18 -3
  96. package/src/resources/v1/index.ts +32 -7
  97. package/src/resources/v1/instrument-data/market-data.ts +2 -1
  98. package/src/resources/v1/instruments.ts +10 -4
  99. package/src/resources/v1/locates.ts +164 -0
  100. package/src/resources/v1/omni-ai/entitlements.ts +84 -9
  101. package/src/resources/v1/omni-ai/index.ts +6 -0
  102. package/src/resources/v1/omni-ai/omni-ai.ts +14 -1
  103. package/src/resources/v1/orders.ts +2 -1
  104. package/src/resources/v1/private-markets/index.ts +32 -38
  105. package/src/resources/v1/private-markets/iois.ts +205 -1
  106. package/src/resources/v1/private-markets/private-markets.ts +622 -209
  107. package/src/resources/v1/v1.ts +64 -14
  108. package/src/version.ts +1 -1
  109. package/version.d.mts +1 -1
  110. package/version.d.ts +1 -1
  111. package/version.js +1 -1
  112. package/version.mjs +1 -1
  113. package/resources/v1/private-markets/companies.d.mts +0 -368
  114. package/resources/v1/private-markets/companies.d.mts.map +0 -1
  115. package/resources/v1/private-markets/companies.d.ts +0 -368
  116. package/resources/v1/private-markets/companies.d.ts.map +0 -1
  117. package/resources/v1/private-markets/companies.js +0 -9
  118. package/resources/v1/private-markets/companies.js.map +0 -1
  119. package/resources/v1/private-markets/companies.mjs +0 -5
  120. package/resources/v1/private-markets/companies.mjs.map +0 -1
  121. package/resources/v1/private-markets/spvs.d.mts +0 -158
  122. package/resources/v1/private-markets/spvs.d.mts.map +0 -1
  123. package/resources/v1/private-markets/spvs.d.ts +0 -158
  124. package/resources/v1/private-markets/spvs.d.ts.map +0 -1
  125. package/resources/v1/private-markets/spvs.js +0 -9
  126. package/resources/v1/private-markets/spvs.js.map +0 -1
  127. package/resources/v1/private-markets/spvs.mjs +0 -5
  128. package/resources/v1/private-markets/spvs.mjs.map +0 -1
  129. package/src/resources/v1/private-markets/companies.ts +0 -483
  130. package/src/resources/v1/private-markets/spvs.ts +0 -201
@@ -1 +1 @@
1
- {"version":3,"file":"instruments.d.mts","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,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,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;OAQG;IACH,iBAAiB,CACf,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAGnD;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,KAAK,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;;OAKG;IACH,6BAA6B,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAE/D;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,KAAK,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE7B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE/D;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAErD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
1
+ {"version":3,"file":"instruments.d.mts","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,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,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;OAQG;IACH,iBAAiB,CACf,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAGnD;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,KAAK,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;;OAKG;IACH,6BAA6B,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAE/D;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,KAAK,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE7B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE/D;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAErD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
@@ -32,8 +32,8 @@ export declare class Instruments extends APIResource {
32
32
  * List options contracts.
33
33
  *
34
34
  * Returns options contracts with options-specific metadata. Exactly one identifier
35
- * must be provided: `underlier`/`underlying_instrument_id` (list all contracts for
36
- * that underlier) or `contract_ids` (look up specific contracts directly).
35
+ * must be provided: `root`/`underlying_instrument_id` (list all contracts for that
36
+ * underlier) or `contract_ids` (look up specific contracts directly).
37
37
  * `expiry`/`contract_type` apply as filters in either case.
38
38
  *
39
39
  * @example
@@ -502,7 +502,7 @@ export interface InstrumentGetOptionContractsParams {
502
502
  /**
503
503
  * Comma-separated contract instrument IDs (UUID) or OSI option symbols to look up
504
504
  * directly, bypassing underlier expansion. Mutually exclusive with
505
- * underlier/underlying_instrument_id; up to 100 values.
505
+ * root/underlying_instrument_id; up to 100 values.
506
506
  */
507
507
  contract_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
508
508
  /**
@@ -529,7 +529,12 @@ export interface InstrumentGetOptionContractsParams {
529
529
  */
530
530
  page_token?: string;
531
531
  /**
532
- * Underlier symbol (e.g., AAPL, SPX)
532
+ * OSI option root symbol (e.g., AAPL, SPXW). Index roots also include their weekly
533
+ * series (e.g., SPX includes SPXW).
534
+ */
535
+ root?: string;
536
+ /**
537
+ * Deprecated: use `root`. If both are sent, the values must match.
533
538
  */
534
539
  underlier?: string;
535
540
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"instruments.d.ts","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,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,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;OAQG;IACH,iBAAiB,CACf,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAGnD;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,KAAK,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;;OAKG;IACH,6BAA6B,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAE/D;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,KAAK,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE7B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE/D;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAErD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
1
+ {"version":3,"file":"instruments.d.ts","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,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,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;OAQG;IACH,iBAAiB,CACf,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAGnD;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,KAAK,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;;OAKG;IACH,6BAA6B,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAE/D;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,KAAK,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE7B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE/D;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAErD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
@@ -36,8 +36,8 @@ class Instruments extends resource_1.APIResource {
36
36
  * List options contracts.
37
37
  *
38
38
  * Returns options contracts with options-specific metadata. Exactly one identifier
39
- * must be provided: `underlier`/`underlying_instrument_id` (list all contracts for
40
- * that underlier) or `contract_ids` (look up specific contracts directly).
39
+ * must be provided: `root`/`underlying_instrument_id` (list all contracts for that
40
+ * underlier) or `contract_ids` (look up specific contracts directly).
41
41
  * `expiry`/`contract_type` apply as filters in either case.
42
42
  *
43
43
  * @example
@@ -33,8 +33,8 @@ export class Instruments extends APIResource {
33
33
  * List options contracts.
34
34
  *
35
35
  * Returns options contracts with options-specific metadata. Exactly one identifier
36
- * must be provided: `underlier`/`underlying_instrument_id` (list all contracts for
37
- * that underlier) or `contract_ids` (look up specific contracts directly).
36
+ * must be provided: `root`/`underlying_instrument_id` (list all contracts for that
37
+ * underlier) or `contract_ids` (look up specific contracts directly).
38
38
  * `expiry`/`contract_type` apply as filters in either case.
39
39
  *
40
40
  * @example
@@ -7,6 +7,21 @@ import { RequestOptions } from "../../internal/request-options.mjs";
7
7
  * Query locate requests, granted locates, and cached locate borrow rates.
8
8
  */
9
9
  export declare class Locates extends APIResource {
10
+ /**
11
+ * > **Beta** — this endpoint may change before general availability.
12
+ *
13
+ * Fetch one locate by id, matched against the locate request id, locate id, and
14
+ * client request id, across all days in force.
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const response = await client.v1.locates.getLocateByID(
19
+ * 'id',
20
+ * { account_id: 0 },
21
+ * );
22
+ * ```
23
+ */
24
+ getLocateByID(id: string, params: LocateGetLocateByIDParams, options?: RequestOptions): APIPromise<LocateGetLocateByIDResponse>;
10
25
  /**
11
26
  * > **Beta** — this endpoint may change before general availability.
12
27
  *
@@ -38,7 +53,79 @@ export declare class Locates extends APIResource {
38
53
  * ```
39
54
  */
40
55
  getLocateRates(query: LocateGetLocateRatesParams, options?: RequestOptions): APIPromise<LocateGetLocateRatesResponse>;
56
+ /**
57
+ * > **Beta** — this endpoint may change before general availability.
58
+ *
59
+ * List locates for the account on one effective date, which defaults to today's
60
+ * New York calendar date. Filter by comma-separated statuses and instrument ids or
61
+ * symbols.
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * const response = await client.v1.locates.getLocates(0);
66
+ * ```
67
+ */
68
+ getLocates(accountID: number, query?: LocateGetLocatesParams | null | undefined, options?: RequestOptions): APIPromise<LocateGetLocatesResponse>;
41
69
  }
70
+ /**
71
+ * A locate request joined with the locate granted for it, if any.
72
+ */
73
+ export interface Locate {
74
+ /**
75
+ * Account the locate is booked to.
76
+ */
77
+ account_id: number;
78
+ /**
79
+ * Caller-assigned id of the locate request.
80
+ */
81
+ client_request_id: string;
82
+ /**
83
+ * New York calendar date the locate is in force for.
84
+ */
85
+ effective_date: string;
86
+ /**
87
+ * Instrument id.
88
+ */
89
+ instrument_id: string;
90
+ /**
91
+ * Engine-assigned locate request id.
92
+ */
93
+ locate_request_id: string;
94
+ /**
95
+ * Number of shares requested.
96
+ */
97
+ requested_quantity: number;
98
+ /**
99
+ * Presented status of the locate.
100
+ */
101
+ status: LocateStatus;
102
+ /**
103
+ * Engine-assigned locate id; set once the locate is granted. When a null/undefined
104
+ * value is observed, it indicates it does not apply.
105
+ */
106
+ locate_id?: string | null;
107
+ /**
108
+ * Number of shares granted; set once the locate is granted. When a null/undefined
109
+ * value is observed, it indicates it does not apply.
110
+ */
111
+ quantity?: number | null;
112
+ /**
113
+ * Client order id the request relates to, if any. When a null/undefined value is
114
+ * observed, it indicates it does not apply.
115
+ */
116
+ related_order_id?: string | null;
117
+ /**
118
+ * Number of granted shares reserved. When a null/undefined value is observed, it
119
+ * indicates it does not apply.
120
+ */
121
+ reserved_quantity?: number | null;
122
+ /**
123
+ * Number of granted shares already used. When a null/undefined value is observed,
124
+ * it indicates it does not apply.
125
+ */
126
+ used_quantity?: number | null;
127
+ }
128
+ export type LocateList = Array<Locate>;
42
129
  /**
43
130
  * A locate borrow rate for an instrument.
44
131
  */
@@ -77,6 +164,17 @@ export interface LocateRateResult {
77
164
  rate?: LocateRate | null;
78
165
  }
79
166
  export type LocateRateResultList = Array<LocateRateResult>;
167
+ /**
168
+ * The presented status of a locate: the locate-request lifecycle plus `EXPIRED`
169
+ * for accepted locates whose effective date has passed.
170
+ */
171
+ export type LocateStatus = 'REQUESTED' | 'ACCEPTED' | 'REJECTED' | 'EXPIRED';
172
+ export interface LocateGetLocateByIDResponse extends Shared.BaseResponse {
173
+ /**
174
+ * A locate request joined with the locate granted for it, if any.
175
+ */
176
+ data: Locate;
177
+ }
80
178
  export interface LocateGetLocateRateByIDResponse extends Shared.BaseResponse {
81
179
  /**
82
180
  * A locate borrow rate for an instrument.
@@ -86,13 +184,37 @@ export interface LocateGetLocateRateByIDResponse extends Shared.BaseResponse {
86
184
  export interface LocateGetLocateRatesResponse extends Shared.BaseResponse {
87
185
  data: LocateRateResultList;
88
186
  }
187
+ export interface LocateGetLocatesResponse extends Shared.BaseResponse {
188
+ data: LocateList;
189
+ }
190
+ export interface LocateGetLocateByIDParams {
191
+ /**
192
+ * Account identifier
193
+ */
194
+ account_id: number;
195
+ }
89
196
  export interface LocateGetLocateRatesParams {
90
197
  /**
91
198
  * Comma-separated instrument IDs (UUID) or symbols; at least one, at most 1,000.
92
199
  */
93
200
  instrument_ids: Array<OrdersAPI.InstrumentIDOrSymbol>;
94
201
  }
202
+ export interface LocateGetLocatesParams {
203
+ /**
204
+ * Effective date to list; defaults to today's New York calendar date. Explicit
205
+ * dates are used unchanged, including weekends and holidays.
206
+ */
207
+ effective_date?: string;
208
+ /**
209
+ * Comma-separated instrument IDs (UUID) or symbols.
210
+ */
211
+ instrument_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
212
+ /**
213
+ * Comma-separated locate statuses to filter by
214
+ */
215
+ status?: Array<'REQUESTED' | 'ACCEPTED' | 'REJECTED' | 'EXPIRED'>;
216
+ }
95
217
  export declare namespace Locates {
96
- export { type LocateRate as LocateRate, type LocateRateResult as LocateRateResult, type LocateRateResultList as LocateRateResultList, type LocateGetLocateRateByIDResponse as LocateGetLocateRateByIDResponse, type LocateGetLocateRatesResponse as LocateGetLocateRatesResponse, type LocateGetLocateRatesParams as LocateGetLocateRatesParams, };
218
+ export { type Locate as Locate, type LocateList as LocateList, type LocateRate as LocateRate, type LocateRateResult as LocateRateResult, type LocateRateResultList as LocateRateResultList, type LocateStatus as LocateStatus, type LocateGetLocateByIDResponse as LocateGetLocateByIDResponse, type LocateGetLocateRateByIDResponse as LocateGetLocateRateByIDResponse, type LocateGetLocateRatesResponse as LocateGetLocateRatesResponse, type LocateGetLocatesResponse as LocateGetLocatesResponse, type LocateGetLocateByIDParams as LocateGetLocateByIDParams, type LocateGetLocateRatesParams as LocateGetLocateRatesParams, type LocateGetLocatesParams as LocateGetLocatesParams, };
97
219
  }
98
220
  //# sourceMappingURL=locates.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"locates.d.mts","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,UAAU,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE3C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAE3D,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;CACvD;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
1
+ {"version":3,"file":"locates.d.mts","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAK1C;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,UAAU,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE3C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7E,MAAM,WAAW,2BAA4B,SAAQ,MAAM,CAAC,YAAY;IACtE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAyB,SAAQ,MAAM,CAAC,YAAY;IACnE,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC,CAAC;CACnE;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
@@ -7,6 +7,21 @@ import { RequestOptions } from "../../internal/request-options.js";
7
7
  * Query locate requests, granted locates, and cached locate borrow rates.
8
8
  */
9
9
  export declare class Locates extends APIResource {
10
+ /**
11
+ * > **Beta** — this endpoint may change before general availability.
12
+ *
13
+ * Fetch one locate by id, matched against the locate request id, locate id, and
14
+ * client request id, across all days in force.
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const response = await client.v1.locates.getLocateByID(
19
+ * 'id',
20
+ * { account_id: 0 },
21
+ * );
22
+ * ```
23
+ */
24
+ getLocateByID(id: string, params: LocateGetLocateByIDParams, options?: RequestOptions): APIPromise<LocateGetLocateByIDResponse>;
10
25
  /**
11
26
  * > **Beta** — this endpoint may change before general availability.
12
27
  *
@@ -38,7 +53,79 @@ export declare class Locates extends APIResource {
38
53
  * ```
39
54
  */
40
55
  getLocateRates(query: LocateGetLocateRatesParams, options?: RequestOptions): APIPromise<LocateGetLocateRatesResponse>;
56
+ /**
57
+ * > **Beta** — this endpoint may change before general availability.
58
+ *
59
+ * List locates for the account on one effective date, which defaults to today's
60
+ * New York calendar date. Filter by comma-separated statuses and instrument ids or
61
+ * symbols.
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * const response = await client.v1.locates.getLocates(0);
66
+ * ```
67
+ */
68
+ getLocates(accountID: number, query?: LocateGetLocatesParams | null | undefined, options?: RequestOptions): APIPromise<LocateGetLocatesResponse>;
41
69
  }
70
+ /**
71
+ * A locate request joined with the locate granted for it, if any.
72
+ */
73
+ export interface Locate {
74
+ /**
75
+ * Account the locate is booked to.
76
+ */
77
+ account_id: number;
78
+ /**
79
+ * Caller-assigned id of the locate request.
80
+ */
81
+ client_request_id: string;
82
+ /**
83
+ * New York calendar date the locate is in force for.
84
+ */
85
+ effective_date: string;
86
+ /**
87
+ * Instrument id.
88
+ */
89
+ instrument_id: string;
90
+ /**
91
+ * Engine-assigned locate request id.
92
+ */
93
+ locate_request_id: string;
94
+ /**
95
+ * Number of shares requested.
96
+ */
97
+ requested_quantity: number;
98
+ /**
99
+ * Presented status of the locate.
100
+ */
101
+ status: LocateStatus;
102
+ /**
103
+ * Engine-assigned locate id; set once the locate is granted. When a null/undefined
104
+ * value is observed, it indicates it does not apply.
105
+ */
106
+ locate_id?: string | null;
107
+ /**
108
+ * Number of shares granted; set once the locate is granted. When a null/undefined
109
+ * value is observed, it indicates it does not apply.
110
+ */
111
+ quantity?: number | null;
112
+ /**
113
+ * Client order id the request relates to, if any. When a null/undefined value is
114
+ * observed, it indicates it does not apply.
115
+ */
116
+ related_order_id?: string | null;
117
+ /**
118
+ * Number of granted shares reserved. When a null/undefined value is observed, it
119
+ * indicates it does not apply.
120
+ */
121
+ reserved_quantity?: number | null;
122
+ /**
123
+ * Number of granted shares already used. When a null/undefined value is observed,
124
+ * it indicates it does not apply.
125
+ */
126
+ used_quantity?: number | null;
127
+ }
128
+ export type LocateList = Array<Locate>;
42
129
  /**
43
130
  * A locate borrow rate for an instrument.
44
131
  */
@@ -77,6 +164,17 @@ export interface LocateRateResult {
77
164
  rate?: LocateRate | null;
78
165
  }
79
166
  export type LocateRateResultList = Array<LocateRateResult>;
167
+ /**
168
+ * The presented status of a locate: the locate-request lifecycle plus `EXPIRED`
169
+ * for accepted locates whose effective date has passed.
170
+ */
171
+ export type LocateStatus = 'REQUESTED' | 'ACCEPTED' | 'REJECTED' | 'EXPIRED';
172
+ export interface LocateGetLocateByIDResponse extends Shared.BaseResponse {
173
+ /**
174
+ * A locate request joined with the locate granted for it, if any.
175
+ */
176
+ data: Locate;
177
+ }
80
178
  export interface LocateGetLocateRateByIDResponse extends Shared.BaseResponse {
81
179
  /**
82
180
  * A locate borrow rate for an instrument.
@@ -86,13 +184,37 @@ export interface LocateGetLocateRateByIDResponse extends Shared.BaseResponse {
86
184
  export interface LocateGetLocateRatesResponse extends Shared.BaseResponse {
87
185
  data: LocateRateResultList;
88
186
  }
187
+ export interface LocateGetLocatesResponse extends Shared.BaseResponse {
188
+ data: LocateList;
189
+ }
190
+ export interface LocateGetLocateByIDParams {
191
+ /**
192
+ * Account identifier
193
+ */
194
+ account_id: number;
195
+ }
89
196
  export interface LocateGetLocateRatesParams {
90
197
  /**
91
198
  * Comma-separated instrument IDs (UUID) or symbols; at least one, at most 1,000.
92
199
  */
93
200
  instrument_ids: Array<OrdersAPI.InstrumentIDOrSymbol>;
94
201
  }
202
+ export interface LocateGetLocatesParams {
203
+ /**
204
+ * Effective date to list; defaults to today's New York calendar date. Explicit
205
+ * dates are used unchanged, including weekends and holidays.
206
+ */
207
+ effective_date?: string;
208
+ /**
209
+ * Comma-separated instrument IDs (UUID) or symbols.
210
+ */
211
+ instrument_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
212
+ /**
213
+ * Comma-separated locate statuses to filter by
214
+ */
215
+ status?: Array<'REQUESTED' | 'ACCEPTED' | 'REJECTED' | 'EXPIRED'>;
216
+ }
95
217
  export declare namespace Locates {
96
- export { type LocateRate as LocateRate, type LocateRateResult as LocateRateResult, type LocateRateResultList as LocateRateResultList, type LocateGetLocateRateByIDResponse as LocateGetLocateRateByIDResponse, type LocateGetLocateRatesResponse as LocateGetLocateRatesResponse, type LocateGetLocateRatesParams as LocateGetLocateRatesParams, };
218
+ export { type Locate as Locate, type LocateList as LocateList, type LocateRate as LocateRate, type LocateRateResult as LocateRateResult, type LocateRateResultList as LocateRateResultList, type LocateStatus as LocateStatus, type LocateGetLocateByIDResponse as LocateGetLocateByIDResponse, type LocateGetLocateRateByIDResponse as LocateGetLocateRateByIDResponse, type LocateGetLocateRatesResponse as LocateGetLocateRatesResponse, type LocateGetLocatesResponse as LocateGetLocatesResponse, type LocateGetLocateByIDParams as LocateGetLocateByIDParams, type LocateGetLocateRatesParams as LocateGetLocateRatesParams, type LocateGetLocatesParams as LocateGetLocatesParams, };
97
219
  }
98
220
  //# sourceMappingURL=locates.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"locates.d.ts","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,UAAU,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE3C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAE3D,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;CACvD;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
1
+ {"version":3,"file":"locates.d.ts","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAK1C;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,UAAU,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE3C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7E,MAAM,WAAW,2BAA4B,SAAQ,MAAM,CAAC,YAAY;IACtE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAyB,SAAQ,MAAM,CAAC,YAAY;IACnE,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC,CAAC;CACnE;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
@@ -8,6 +8,24 @@ const path_1 = require("../../internal/utils/path.js");
8
8
  * Query locate requests, granted locates, and cached locate borrow rates.
9
9
  */
10
10
  class Locates extends resource_1.APIResource {
11
+ /**
12
+ * > **Beta** — this endpoint may change before general availability.
13
+ *
14
+ * Fetch one locate by id, matched against the locate request id, locate id, and
15
+ * client request id, across all days in force.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * const response = await client.v1.locates.getLocateByID(
20
+ * 'id',
21
+ * { account_id: 0 },
22
+ * );
23
+ * ```
24
+ */
25
+ getLocateByID(id, params, options) {
26
+ const { account_id } = params;
27
+ return this._client.get((0, path_1.path) `/v1/accounts/${account_id}/locates/${id}`, options);
28
+ }
11
29
  /**
12
30
  * > **Beta** — this endpoint may change before general availability.
13
31
  *
@@ -43,6 +61,21 @@ class Locates extends resource_1.APIResource {
43
61
  getLocateRates(query, options) {
44
62
  return this._client.get('/v1/locates/rates', { query, ...options });
45
63
  }
64
+ /**
65
+ * > **Beta** — this endpoint may change before general availability.
66
+ *
67
+ * List locates for the account on one effective date, which defaults to today's
68
+ * New York calendar date. Filter by comma-separated statuses and instrument ids or
69
+ * symbols.
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * const response = await client.v1.locates.getLocates(0);
74
+ * ```
75
+ */
76
+ getLocates(accountID, query = {}, options) {
77
+ return this._client.get((0, path_1.path) `/v1/accounts/${accountID}/locates`, { query, ...options });
78
+ }
46
79
  }
47
80
  exports.Locates = Locates;
48
81
  //# sourceMappingURL=locates.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"locates.js","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AA3CD,0BA2CC"}
1
+ {"version":3,"file":"locates.js","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,EAAU,EACV,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,UAAU,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAiB,EACjB,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAtFD,0BAsFC"}
@@ -5,6 +5,24 @@ import { path } from "../../internal/utils/path.mjs";
5
5
  * Query locate requests, granted locates, and cached locate borrow rates.
6
6
  */
7
7
  export class Locates extends APIResource {
8
+ /**
9
+ * > **Beta** — this endpoint may change before general availability.
10
+ *
11
+ * Fetch one locate by id, matched against the locate request id, locate id, and
12
+ * client request id, across all days in force.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const response = await client.v1.locates.getLocateByID(
17
+ * 'id',
18
+ * { account_id: 0 },
19
+ * );
20
+ * ```
21
+ */
22
+ getLocateByID(id, params, options) {
23
+ const { account_id } = params;
24
+ return this._client.get(path `/v1/accounts/${account_id}/locates/${id}`, options);
25
+ }
8
26
  /**
9
27
  * > **Beta** — this endpoint may change before general availability.
10
28
  *
@@ -40,5 +58,20 @@ export class Locates extends APIResource {
40
58
  getLocateRates(query, options) {
41
59
  return this._client.get('/v1/locates/rates', { query, ...options });
42
60
  }
61
+ /**
62
+ * > **Beta** — this endpoint may change before general availability.
63
+ *
64
+ * List locates for the account on one effective date, which defaults to today's
65
+ * New York calendar date. Filter by comma-separated statuses and instrument ids or
66
+ * symbols.
67
+ *
68
+ * @example
69
+ * ```ts
70
+ * const response = await client.v1.locates.getLocates(0);
71
+ * ```
72
+ */
73
+ getLocates(accountID, query = {}, options) {
74
+ return this._client.get(path `/v1/accounts/${accountID}/locates`, { query, ...options });
75
+ }
43
76
  }
44
77
  //# sourceMappingURL=locates.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"locates.mjs","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAKlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}
1
+ {"version":3,"file":"locates.mjs","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAKlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,EAAU,EACV,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,UAAU,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAiB,EACjB,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF"}