kalshi-typescript 2.1.2 → 3.0.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 (888) hide show
  1. package/.openapi-generator/FILES +112 -42
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +110 -50
  4. package/api/api-keys-api.ts +57 -39
  5. package/api/collection-api.ts +506 -0
  6. package/api/communications-api.ts +296 -114
  7. package/api/events-api.ts +406 -57
  8. package/api/exchange-api.ts +104 -29
  9. package/api/fcm-api.ts +337 -0
  10. package/api/incentive-programs-api.ts +168 -0
  11. package/api/live-data-api.ts +207 -0
  12. package/api/market-api.ts +872 -0
  13. package/api/markets-api.ts +23 -24
  14. package/api/milestone-api.ts +258 -0
  15. package/api/milestones-api.ts +5 -6
  16. package/api/multivariate-api.ts +505 -0
  17. package/api/multivariate-collections-api.ts +11 -12
  18. package/api/order-groups-api.ts +454 -0
  19. package/api/orders-api.ts +941 -0
  20. package/api/portfolio-api.ts +204 -1355
  21. package/api/search-api.ts +183 -0
  22. package/api/series-api.ts +5 -6
  23. package/api/structured-targets-api.ts +47 -41
  24. package/api.ts +13 -8
  25. package/auth.ts +1 -1
  26. package/base.ts +8 -8
  27. package/common.ts +4 -4
  28. package/configuration.ts +4 -5
  29. package/dist/api/api-keys-api.d.ts +20 -20
  30. package/dist/api/api-keys-api.js +52 -40
  31. package/dist/api/collection-api.d.ts +242 -0
  32. package/dist/api/collection-api.js +467 -0
  33. package/dist/api/communications-api.d.ts +124 -60
  34. package/dist/api/communications-api.js +268 -124
  35. package/dist/api/events-api.d.ts +210 -36
  36. package/dist/api/events-api.js +376 -56
  37. package/dist/api/exchange-api.d.ts +57 -20
  38. package/dist/api/exchange-api.js +100 -31
  39. package/dist/api/fcm-api.d.ts +164 -0
  40. package/dist/api/fcm-api.js +313 -0
  41. package/dist/api/incentive-programs-api.d.ts +93 -0
  42. package/dist/api/incentive-programs-api.js +164 -0
  43. package/dist/api/live-data-api.d.ts +104 -0
  44. package/dist/api/live-data-api.js +205 -0
  45. package/dist/api/market-api.d.ts +417 -0
  46. package/dist/api/market-api.js +804 -0
  47. package/dist/api/markets-api.js +10 -10
  48. package/dist/api/milestone-api.d.ts +128 -0
  49. package/dist/api/milestone-api.js +249 -0
  50. package/dist/api/milestones-api.js +4 -4
  51. package/dist/api/multivariate-api.d.ts +242 -0
  52. package/dist/api/multivariate-api.js +467 -0
  53. package/dist/api/multivariate-collections-api.js +6 -6
  54. package/dist/api/order-groups-api.d.ts +198 -0
  55. package/dist/api/order-groups-api.js +421 -0
  56. package/dist/api/orders-api.d.ts +405 -0
  57. package/dist/api/orders-api.js +844 -0
  58. package/dist/api/portfolio-api.d.ts +83 -601
  59. package/dist/api/portfolio-api.js +164 -1213
  60. package/dist/api/search-api.d.ts +92 -0
  61. package/dist/api/search-api.js +182 -0
  62. package/dist/api/series-api.js +4 -4
  63. package/dist/api/structured-targets-api.d.ts +32 -24
  64. package/dist/api/structured-targets-api.js +47 -39
  65. package/dist/api.d.ts +13 -8
  66. package/dist/api.js +13 -8
  67. package/dist/base.d.ts +4 -4
  68. package/dist/base.js +4 -4
  69. package/dist/common.d.ts +4 -4
  70. package/dist/common.js +4 -4
  71. package/dist/configuration.d.ts +4 -4
  72. package/dist/configuration.js +4 -4
  73. package/dist/esm/api/api-keys-api.d.ts +20 -20
  74. package/dist/esm/api/api-keys-api.js +54 -42
  75. package/dist/esm/api/collection-api.d.ts +242 -0
  76. package/dist/esm/api/collection-api.js +460 -0
  77. package/dist/esm/api/communications-api.d.ts +124 -60
  78. package/dist/esm/api/communications-api.js +270 -126
  79. package/dist/esm/api/events-api.d.ts +210 -36
  80. package/dist/esm/api/events-api.js +377 -57
  81. package/dist/esm/api/exchange-api.d.ts +57 -20
  82. package/dist/esm/api/exchange-api.js +102 -33
  83. package/dist/esm/api/fcm-api.d.ts +164 -0
  84. package/dist/esm/api/fcm-api.js +306 -0
  85. package/dist/esm/api/incentive-programs-api.d.ts +93 -0
  86. package/dist/esm/api/incentive-programs-api.js +157 -0
  87. package/dist/esm/api/live-data-api.d.ts +104 -0
  88. package/dist/esm/api/live-data-api.js +198 -0
  89. package/dist/esm/api/market-api.d.ts +417 -0
  90. package/dist/esm/api/market-api.js +797 -0
  91. package/dist/esm/api/markets-api.js +11 -11
  92. package/dist/esm/api/milestone-api.d.ts +128 -0
  93. package/dist/esm/api/milestone-api.js +242 -0
  94. package/dist/esm/api/milestones-api.js +5 -5
  95. package/dist/esm/api/multivariate-api.d.ts +242 -0
  96. package/dist/esm/api/multivariate-api.js +460 -0
  97. package/dist/esm/api/multivariate-collections-api.js +7 -7
  98. package/dist/esm/api/order-groups-api.d.ts +198 -0
  99. package/dist/esm/api/order-groups-api.js +414 -0
  100. package/dist/esm/api/orders-api.d.ts +405 -0
  101. package/dist/esm/api/orders-api.js +837 -0
  102. package/dist/esm/api/portfolio-api.d.ts +83 -601
  103. package/dist/esm/api/portfolio-api.js +164 -1213
  104. package/dist/esm/api/search-api.d.ts +92 -0
  105. package/dist/esm/api/search-api.js +175 -0
  106. package/dist/esm/api/series-api.js +5 -5
  107. package/dist/esm/api/structured-targets-api.d.ts +32 -24
  108. package/dist/esm/api/structured-targets-api.js +49 -41
  109. package/dist/esm/api.d.ts +13 -8
  110. package/dist/esm/api.js +13 -8
  111. package/dist/esm/base.d.ts +4 -4
  112. package/dist/esm/base.js +4 -4
  113. package/dist/esm/common.d.ts +4 -4
  114. package/dist/esm/common.js +4 -4
  115. package/dist/esm/configuration.d.ts +4 -4
  116. package/dist/esm/configuration.js +4 -4
  117. package/dist/esm/index.d.ts +4 -4
  118. package/dist/esm/index.js +4 -4
  119. package/dist/esm/models/accept-quote-request.d.ts +13 -5
  120. package/dist/esm/models/accept-quote-request.js +8 -5
  121. package/dist/esm/models/amend-order-request.d.ts +27 -10
  122. package/dist/esm/models/amend-order-request.js +4 -4
  123. package/dist/esm/models/amend-order-response.d.ts +6 -5
  124. package/dist/esm/models/amend-order-response.js +4 -4
  125. package/dist/esm/models/announcement.d.ts +25 -13
  126. package/dist/esm/models/announcement.js +8 -8
  127. package/dist/esm/models/api-key.d.ts +4 -8
  128. package/dist/esm/models/api-key.js +4 -4
  129. package/dist/esm/models/associated-event.d.ts +33 -0
  130. package/dist/esm/models/associated-event.js +14 -0
  131. package/dist/esm/models/batch-cancel-orders-individual-response.d.ts +25 -0
  132. package/dist/esm/models/batch-cancel-orders-individual-response.js +14 -0
  133. package/dist/esm/models/batch-cancel-orders-request.d.ts +8 -5
  134. package/dist/esm/models/batch-cancel-orders-request.js +4 -4
  135. package/dist/esm/models/batch-cancel-orders-response.d.ts +6 -6
  136. package/dist/esm/models/batch-cancel-orders-response.js +4 -4
  137. package/dist/esm/models/batch-create-orders-individual-response.d.ts +18 -0
  138. package/dist/esm/models/batch-create-orders-individual-response.js +14 -0
  139. package/dist/esm/models/batch-create-orders-request.d.ts +4 -4
  140. package/dist/esm/models/batch-create-orders-request.js +4 -4
  141. package/dist/esm/models/batch-create-orders-response.d.ts +6 -6
  142. package/dist/esm/models/batch-create-orders-response.js +4 -4
  143. package/dist/esm/models/batch-get-market-candlesticks-response.d.ts +18 -0
  144. package/dist/esm/models/batch-get-market-candlesticks-response.js +14 -0
  145. package/dist/esm/models/bid-ask-distribution.d.ts +45 -0
  146. package/dist/esm/models/bid-ask-distribution.js +14 -0
  147. package/dist/esm/models/cancel-order-response.d.ts +6 -6
  148. package/dist/esm/models/cancel-order-response.js +4 -4
  149. package/dist/esm/models/create-api-key-request.d.ts +4 -4
  150. package/dist/esm/models/create-api-key-request.js +4 -4
  151. package/dist/esm/models/create-api-key-response.d.ts +4 -4
  152. package/dist/esm/models/create-api-key-response.js +4 -4
  153. package/dist/esm/models/create-market-in-multivariate-event-collection-request.d.ts +18 -0
  154. package/dist/esm/models/create-market-in-multivariate-event-collection-request.js +14 -0
  155. package/dist/esm/models/create-market-in-multivariate-event-collection-response.d.ts +21 -0
  156. package/dist/esm/models/create-market-in-multivariate-event-collection-response.js +14 -0
  157. package/dist/esm/models/create-order-group-request.d.ts +5 -5
  158. package/dist/esm/models/create-order-group-request.js +4 -4
  159. package/dist/esm/models/create-order-group-response.d.ts +5 -5
  160. package/dist/esm/models/create-order-group-response.js +4 -4
  161. package/dist/esm/models/create-order-request.d.ts +34 -9
  162. package/dist/esm/models/create-order-request.js +9 -4
  163. package/dist/esm/models/create-order-response.d.ts +5 -5
  164. package/dist/esm/models/create-order-response.js +4 -4
  165. package/dist/esm/models/create-quote-request.d.ts +19 -6
  166. package/dist/esm/models/create-quote-request.js +4 -4
  167. package/dist/esm/models/create-quote-response.d.ts +8 -6
  168. package/dist/esm/models/create-quote-response.js +4 -4
  169. package/dist/esm/models/create-rfqrequest.d.ts +28 -13
  170. package/dist/esm/models/create-rfqrequest.js +5 -8
  171. package/dist/esm/models/create-rfqresponse.d.ts +8 -6
  172. package/dist/esm/models/create-rfqresponse.js +4 -4
  173. package/dist/esm/models/daily-schedule.d.ts +12 -6
  174. package/dist/esm/models/daily-schedule.js +4 -4
  175. package/dist/esm/models/decrease-order-request.d.ts +6 -5
  176. package/dist/esm/models/decrease-order-request.js +4 -4
  177. package/dist/esm/models/decrease-order-response.d.ts +5 -5
  178. package/dist/esm/models/decrease-order-response.js +4 -4
  179. package/dist/esm/models/error-response.d.ts +20 -6
  180. package/dist/esm/models/error-response.js +4 -4
  181. package/dist/esm/models/event-data.d.ts +62 -0
  182. package/dist/esm/models/event-data.js +14 -0
  183. package/dist/esm/models/event-position.d.ts +24 -24
  184. package/dist/esm/models/event-position.js +4 -4
  185. package/dist/esm/models/exchange-status.d.ts +16 -6
  186. package/dist/esm/models/exchange-status.js +4 -4
  187. package/dist/esm/models/fill.d.ts +71 -12
  188. package/dist/esm/models/fill.js +4 -4
  189. package/dist/esm/models/forecast-percentiles-point.d.ts +30 -0
  190. package/dist/esm/models/forecast-percentiles-point.js +14 -0
  191. package/dist/esm/models/generate-api-key-request.d.ts +4 -4
  192. package/dist/esm/models/generate-api-key-request.js +4 -4
  193. package/dist/esm/models/generate-api-key-response.d.ts +4 -4
  194. package/dist/esm/models/generate-api-key-response.js +4 -4
  195. package/dist/esm/models/get-api-keys-response.d.ts +4 -4
  196. package/dist/esm/models/get-api-keys-response.js +4 -4
  197. package/dist/esm/models/get-balance-response.d.ts +14 -6
  198. package/dist/esm/models/get-balance-response.js +4 -4
  199. package/dist/esm/models/get-communications-idresponse.d.ts +6 -6
  200. package/dist/esm/models/get-communications-idresponse.js +4 -4
  201. package/dist/esm/models/get-event-candlesticks-response.d.ts +26 -0
  202. package/dist/esm/models/get-event-candlesticks-response.js +14 -0
  203. package/dist/esm/models/get-event-forecast-percentiles-history-response.d.ts +18 -0
  204. package/dist/esm/models/get-event-forecast-percentiles-history-response.js +14 -0
  205. package/dist/esm/models/get-event-metadata-response.d.ts +30 -5
  206. package/dist/esm/models/get-event-metadata-response.js +4 -4
  207. package/dist/esm/models/get-event-response.d.ts +10 -7
  208. package/dist/esm/models/get-event-response.js +4 -4
  209. package/dist/esm/models/get-events-candlesticks-response-events-inner.d.ts +30 -0
  210. package/dist/esm/models/get-events-candlesticks-response-events-inner.js +14 -0
  211. package/dist/esm/models/get-events-candlesticks-response.d.ts +18 -0
  212. package/dist/esm/models/get-events-candlesticks-response.js +14 -0
  213. package/dist/esm/models/get-events-response.d.ts +18 -7
  214. package/dist/esm/models/get-events-response.js +4 -4
  215. package/dist/esm/models/get-exchange-announcements-response.d.ts +8 -5
  216. package/dist/esm/models/get-exchange-announcements-response.js +4 -4
  217. package/dist/esm/models/get-exchange-schedule-response.d.ts +6 -6
  218. package/dist/esm/models/get-exchange-schedule-response.js +4 -4
  219. package/dist/esm/models/get-fills-response.d.ts +6 -6
  220. package/dist/esm/models/get-fills-response.js +4 -4
  221. package/dist/esm/models/get-filters-by-sports-response.d.ts +24 -0
  222. package/dist/esm/models/get-filters-by-sports-response.js +14 -0
  223. package/dist/esm/models/get-incentive-programs-response.d.ts +19 -0
  224. package/dist/esm/models/get-incentive-programs-response.js +14 -0
  225. package/dist/esm/models/get-live-data-response.d.ts +15 -0
  226. package/dist/esm/models/get-live-data-response.js +14 -0
  227. package/dist/esm/models/get-live-datas-response.d.ts +15 -0
  228. package/dist/esm/models/get-live-datas-response.js +14 -0
  229. package/dist/esm/models/get-market-candlesticks-response.d.ts +13 -6
  230. package/dist/esm/models/get-market-candlesticks-response.js +4 -4
  231. package/dist/esm/models/get-market-orderbook-response.d.ts +6 -6
  232. package/dist/esm/models/get-market-orderbook-response.js +4 -4
  233. package/dist/esm/models/get-market-response.d.ts +5 -5
  234. package/dist/esm/models/get-market-response.js +4 -4
  235. package/dist/esm/models/get-markets-response.d.ts +6 -6
  236. package/dist/esm/models/get-markets-response.js +4 -4
  237. package/dist/esm/models/get-milestone-response.d.ts +5 -5
  238. package/dist/esm/models/get-milestone-response.js +4 -4
  239. package/dist/esm/models/get-milestones-response.d.ts +12 -5
  240. package/dist/esm/models/get-milestones-response.js +4 -4
  241. package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.d.ts +18 -0
  242. package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.js +14 -0
  243. package/dist/esm/models/get-multivariate-event-collection-response.d.ts +5 -5
  244. package/dist/esm/models/get-multivariate-event-collection-response.js +4 -4
  245. package/dist/esm/models/get-multivariate-event-collections-response.d.ts +12 -5
  246. package/dist/esm/models/get-multivariate-event-collections-response.js +4 -4
  247. package/dist/esm/models/get-multivariate-events-response.d.ts +22 -0
  248. package/dist/esm/models/get-multivariate-events-response.js +14 -0
  249. package/dist/esm/models/get-order-group-response.d.ts +6 -6
  250. package/dist/esm/models/get-order-group-response.js +4 -4
  251. package/dist/esm/models/get-order-groups-response.d.ts +4 -5
  252. package/dist/esm/models/get-order-groups-response.js +4 -4
  253. package/dist/esm/models/get-order-queue-position-response.d.ts +8 -5
  254. package/dist/esm/models/get-order-queue-position-response.js +4 -4
  255. package/dist/esm/models/get-order-queue-positions-response.d.ts +18 -0
  256. package/dist/esm/models/get-order-queue-positions-response.js +14 -0
  257. package/dist/esm/models/get-order-response.d.ts +4 -4
  258. package/dist/esm/models/get-order-response.js +4 -4
  259. package/dist/esm/models/get-orders-response.d.ts +6 -6
  260. package/dist/esm/models/get-orders-response.js +4 -4
  261. package/dist/esm/models/get-portfolio-resting-order-total-value-response.d.ts +17 -0
  262. package/dist/esm/models/get-portfolio-resting-order-total-value-response.js +14 -0
  263. package/dist/esm/models/get-positions-response.d.ts +16 -7
  264. package/dist/esm/models/get-positions-response.js +4 -4
  265. package/dist/esm/models/get-quote-response.d.ts +5 -5
  266. package/dist/esm/models/get-quote-response.js +4 -4
  267. package/dist/esm/models/get-quotes-response.d.ts +12 -5
  268. package/dist/esm/models/get-quotes-response.js +4 -4
  269. package/dist/esm/models/get-rfqresponse.d.ts +5 -5
  270. package/dist/esm/models/get-rfqresponse.js +4 -4
  271. package/dist/esm/models/get-rfqs-response.d.ts +12 -5
  272. package/dist/esm/models/get-rfqs-response.js +4 -4
  273. package/dist/esm/models/get-series-fee-changes-response.d.ts +15 -0
  274. package/dist/esm/models/get-series-fee-changes-response.js +14 -0
  275. package/dist/esm/models/get-series-list-response.d.ts +15 -0
  276. package/dist/esm/models/get-series-list-response.js +14 -0
  277. package/dist/esm/models/get-series-response.d.ts +5 -5
  278. package/dist/esm/models/get-series-response.js +4 -4
  279. package/dist/esm/models/get-settlements-response.d.ts +5 -5
  280. package/dist/esm/models/get-settlements-response.js +4 -4
  281. package/dist/esm/models/get-structured-target-response.d.ts +4 -4
  282. package/dist/esm/models/get-structured-target-response.js +4 -4
  283. package/dist/esm/models/get-structured-targets-response.d.ts +8 -4
  284. package/dist/esm/models/get-structured-targets-response.js +4 -4
  285. package/dist/esm/models/get-tags-for-series-categories-response.d.ts +19 -0
  286. package/dist/esm/models/get-tags-for-series-categories-response.js +14 -0
  287. package/dist/esm/models/get-trades-response.d.ts +6 -6
  288. package/dist/esm/models/get-trades-response.js +4 -4
  289. package/dist/esm/models/get-user-data-timestamp-response.d.ts +8 -5
  290. package/dist/esm/models/get-user-data-timestamp-response.js +4 -4
  291. package/dist/esm/models/incentive-program.d.ts +54 -0
  292. package/dist/esm/models/incentive-program.js +17 -0
  293. package/dist/esm/models/index.d.ts +47 -17
  294. package/dist/esm/models/index.js +47 -17
  295. package/dist/esm/models/live-data.d.ts +27 -0
  296. package/dist/esm/models/live-data.js +14 -0
  297. package/dist/esm/models/lookup-point.d.ts +30 -0
  298. package/dist/esm/models/lookup-point.js +14 -0
  299. package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +18 -0
  300. package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +14 -0
  301. package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +21 -0
  302. package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +14 -0
  303. package/dist/esm/models/maintenance-window.d.ts +21 -0
  304. package/dist/esm/models/maintenance-window.js +14 -0
  305. package/dist/esm/models/market-candlestick.d.ts +30 -0
  306. package/dist/esm/models/market-candlestick.js +14 -0
  307. package/dist/esm/models/market-candlesticks-response.d.ts +22 -0
  308. package/dist/esm/models/market-candlesticks-response.js +14 -0
  309. package/dist/esm/models/market-metadata.d.ts +25 -0
  310. package/dist/esm/models/market-metadata.js +14 -0
  311. package/dist/esm/models/market-position.d.ts +61 -0
  312. package/dist/esm/models/market-position.js +14 -0
  313. package/dist/esm/models/market.d.ts +219 -26
  314. package/dist/esm/models/market.js +21 -4
  315. package/dist/esm/models/milestone.d.ts +54 -7
  316. package/dist/esm/models/milestone.js +4 -4
  317. package/dist/esm/models/multivariate-event-collection.d.ts +61 -9
  318. package/dist/esm/models/multivariate-event-collection.js +4 -4
  319. package/dist/esm/models/mve-selected-leg.d.ts +25 -0
  320. package/dist/esm/models/mve-selected-leg.js +14 -0
  321. package/dist/esm/models/order-group.d.ts +5 -5
  322. package/dist/esm/models/order-group.js +4 -4
  323. package/dist/esm/models/order-queue-position.d.ts +25 -0
  324. package/dist/esm/models/order-queue-position.js +14 -0
  325. package/dist/esm/models/order-status.d.ts +20 -0
  326. package/dist/esm/models/order-status.js +21 -0
  327. package/dist/esm/models/order.d.ts +75 -29
  328. package/dist/esm/models/order.js +4 -10
  329. package/dist/esm/models/orderbook.d.ts +17 -0
  330. package/dist/esm/models/orderbook.js +14 -0
  331. package/dist/esm/models/percentile-point.d.ts +29 -0
  332. package/dist/esm/models/percentile-point.js +14 -0
  333. package/dist/esm/models/price-distribution.d.ts +77 -0
  334. package/dist/esm/models/price-distribution.js +14 -0
  335. package/dist/esm/models/price-range.d.ts +25 -0
  336. package/dist/esm/models/price-range.js +14 -0
  337. package/dist/esm/models/quote.d.ts +116 -17
  338. package/dist/esm/models/quote.js +14 -7
  339. package/dist/esm/models/rfq.d.ts +65 -16
  340. package/dist/esm/models/rfq.js +7 -7
  341. package/dist/esm/models/schedule.d.ts +23 -0
  342. package/dist/esm/models/schedule.js +14 -0
  343. package/dist/esm/models/scope-list.d.ts +17 -0
  344. package/dist/esm/models/scope-list.js +14 -0
  345. package/dist/esm/models/self-trade-prevention-type.d.ts +19 -0
  346. package/dist/esm/models/self-trade-prevention-type.js +20 -0
  347. package/dist/esm/models/series-fee-change.d.ts +39 -0
  348. package/dist/esm/models/series-fee-change.js +18 -0
  349. package/dist/esm/models/series.d.ts +57 -9
  350. package/dist/esm/models/series.js +9 -5
  351. package/dist/esm/models/settlement-source.d.ts +21 -0
  352. package/dist/esm/models/settlement-source.js +14 -0
  353. package/dist/esm/models/settlement.d.ts +48 -12
  354. package/dist/esm/models/settlement.js +8 -6
  355. package/dist/esm/models/sport-filter-details.d.ts +24 -0
  356. package/dist/esm/models/sport-filter-details.js +14 -0
  357. package/dist/esm/models/structured-target.d.ts +28 -7
  358. package/dist/esm/models/structured-target.js +4 -4
  359. package/dist/esm/models/ticker-pair.d.ts +30 -0
  360. package/dist/esm/models/ticker-pair.js +17 -0
  361. package/dist/esm/models/trade.d.ts +45 -11
  362. package/dist/esm/models/trade.js +6 -6
  363. package/dist/esm/models/weekly-schedule.d.ts +50 -0
  364. package/dist/esm/models/weekly-schedule.js +14 -0
  365. package/dist/index.d.ts +4 -4
  366. package/dist/index.js +4 -4
  367. package/dist/models/accept-quote-request.d.ts +13 -5
  368. package/dist/models/accept-quote-request.js +9 -4
  369. package/dist/models/amend-order-request.d.ts +27 -10
  370. package/dist/models/amend-order-request.js +4 -4
  371. package/dist/models/amend-order-response.d.ts +6 -5
  372. package/dist/models/amend-order-response.js +4 -4
  373. package/dist/models/announcement.d.ts +25 -13
  374. package/dist/models/announcement.js +9 -9
  375. package/dist/models/api-key.d.ts +4 -8
  376. package/dist/models/api-key.js +4 -4
  377. package/dist/models/associated-event.d.ts +33 -0
  378. package/dist/models/associated-event.js +15 -0
  379. package/dist/models/batch-cancel-orders-individual-response.d.ts +25 -0
  380. package/dist/models/batch-cancel-orders-individual-response.js +15 -0
  381. package/dist/models/batch-cancel-orders-request.d.ts +8 -5
  382. package/dist/models/batch-cancel-orders-request.js +4 -4
  383. package/dist/models/batch-cancel-orders-response.d.ts +6 -6
  384. package/dist/models/batch-cancel-orders-response.js +4 -4
  385. package/dist/models/batch-create-orders-individual-response.d.ts +18 -0
  386. package/dist/models/batch-create-orders-individual-response.js +15 -0
  387. package/dist/models/batch-create-orders-request.d.ts +4 -4
  388. package/dist/models/batch-create-orders-request.js +4 -4
  389. package/dist/models/batch-create-orders-response.d.ts +6 -6
  390. package/dist/models/batch-create-orders-response.js +4 -4
  391. package/dist/models/batch-get-market-candlesticks-response.d.ts +18 -0
  392. package/dist/models/batch-get-market-candlesticks-response.js +15 -0
  393. package/dist/models/bid-ask-distribution.d.ts +45 -0
  394. package/dist/models/bid-ask-distribution.js +15 -0
  395. package/dist/models/cancel-order-response.d.ts +6 -6
  396. package/dist/models/cancel-order-response.js +4 -4
  397. package/dist/models/create-api-key-request.d.ts +4 -4
  398. package/dist/models/create-api-key-request.js +4 -4
  399. package/dist/models/create-api-key-response.d.ts +4 -4
  400. package/dist/models/create-api-key-response.js +4 -4
  401. package/dist/models/create-market-in-multivariate-event-collection-request.d.ts +18 -0
  402. package/dist/models/create-market-in-multivariate-event-collection-request.js +15 -0
  403. package/dist/models/create-market-in-multivariate-event-collection-response.d.ts +21 -0
  404. package/dist/models/create-market-in-multivariate-event-collection-response.js +15 -0
  405. package/dist/models/create-order-group-request.d.ts +5 -5
  406. package/dist/models/create-order-group-request.js +4 -4
  407. package/dist/models/create-order-group-response.d.ts +5 -5
  408. package/dist/models/create-order-group-response.js +4 -4
  409. package/dist/models/create-order-request.d.ts +34 -9
  410. package/dist/models/create-order-request.js +10 -5
  411. package/dist/models/create-order-response.d.ts +5 -5
  412. package/dist/models/create-order-response.js +4 -4
  413. package/dist/models/create-quote-request.d.ts +19 -6
  414. package/dist/models/create-quote-request.js +4 -4
  415. package/dist/models/create-quote-response.d.ts +8 -6
  416. package/dist/models/create-quote-response.js +4 -4
  417. package/dist/models/create-rfqrequest.d.ts +28 -13
  418. package/dist/models/create-rfqrequest.js +4 -9
  419. package/dist/models/create-rfqresponse.d.ts +8 -6
  420. package/dist/models/create-rfqresponse.js +4 -4
  421. package/dist/models/daily-schedule.d.ts +12 -6
  422. package/dist/models/daily-schedule.js +4 -4
  423. package/dist/models/decrease-order-request.d.ts +6 -5
  424. package/dist/models/decrease-order-request.js +4 -4
  425. package/dist/models/decrease-order-response.d.ts +5 -5
  426. package/dist/models/decrease-order-response.js +4 -4
  427. package/dist/models/error-response.d.ts +20 -6
  428. package/dist/models/error-response.js +4 -4
  429. package/dist/models/event-data.d.ts +62 -0
  430. package/dist/models/event-data.js +15 -0
  431. package/dist/models/event-position.d.ts +24 -24
  432. package/dist/models/event-position.js +4 -4
  433. package/dist/models/exchange-status.d.ts +16 -6
  434. package/dist/models/exchange-status.js +4 -4
  435. package/dist/models/fill.d.ts +71 -12
  436. package/dist/models/fill.js +4 -4
  437. package/dist/models/forecast-percentiles-point.d.ts +30 -0
  438. package/dist/models/forecast-percentiles-point.js +15 -0
  439. package/dist/models/generate-api-key-request.d.ts +4 -4
  440. package/dist/models/generate-api-key-request.js +4 -4
  441. package/dist/models/generate-api-key-response.d.ts +4 -4
  442. package/dist/models/generate-api-key-response.js +4 -4
  443. package/dist/models/get-api-keys-response.d.ts +4 -4
  444. package/dist/models/get-api-keys-response.js +4 -4
  445. package/dist/models/get-balance-response.d.ts +14 -6
  446. package/dist/models/get-balance-response.js +4 -4
  447. package/dist/models/get-communications-idresponse.d.ts +6 -6
  448. package/dist/models/get-communications-idresponse.js +4 -4
  449. package/dist/models/get-event-candlesticks-response.d.ts +26 -0
  450. package/dist/models/get-event-candlesticks-response.js +15 -0
  451. package/dist/models/get-event-forecast-percentiles-history-response.d.ts +18 -0
  452. package/dist/models/get-event-forecast-percentiles-history-response.js +15 -0
  453. package/dist/models/get-event-metadata-response.d.ts +30 -5
  454. package/dist/models/get-event-metadata-response.js +4 -4
  455. package/dist/models/get-event-response.d.ts +10 -7
  456. package/dist/models/get-event-response.js +4 -4
  457. package/dist/models/get-events-candlesticks-response-events-inner.d.ts +30 -0
  458. package/dist/models/get-events-candlesticks-response-events-inner.js +15 -0
  459. package/dist/models/get-events-candlesticks-response.d.ts +18 -0
  460. package/dist/models/get-events-candlesticks-response.js +15 -0
  461. package/dist/models/get-events-response.d.ts +18 -7
  462. package/dist/models/get-events-response.js +4 -4
  463. package/dist/models/get-exchange-announcements-response.d.ts +8 -5
  464. package/dist/models/get-exchange-announcements-response.js +4 -4
  465. package/dist/models/get-exchange-schedule-response.d.ts +6 -6
  466. package/dist/models/get-exchange-schedule-response.js +4 -4
  467. package/dist/models/get-fills-response.d.ts +6 -6
  468. package/dist/models/get-fills-response.js +4 -4
  469. package/dist/models/get-filters-by-sports-response.d.ts +24 -0
  470. package/dist/models/get-filters-by-sports-response.js +15 -0
  471. package/dist/models/get-incentive-programs-response.d.ts +19 -0
  472. package/dist/models/get-incentive-programs-response.js +15 -0
  473. package/dist/models/get-live-data-response.d.ts +15 -0
  474. package/dist/models/get-live-data-response.js +15 -0
  475. package/dist/models/get-live-datas-response.d.ts +15 -0
  476. package/dist/models/get-live-datas-response.js +15 -0
  477. package/dist/models/get-market-candlesticks-response.d.ts +13 -6
  478. package/dist/models/get-market-candlesticks-response.js +4 -4
  479. package/dist/models/get-market-orderbook-response.d.ts +6 -6
  480. package/dist/models/get-market-orderbook-response.js +4 -4
  481. package/dist/models/get-market-response.d.ts +5 -5
  482. package/dist/models/get-market-response.js +4 -4
  483. package/dist/models/get-markets-response.d.ts +6 -6
  484. package/dist/models/get-markets-response.js +4 -4
  485. package/dist/models/get-milestone-response.d.ts +5 -5
  486. package/dist/models/get-milestone-response.js +4 -4
  487. package/dist/models/get-milestones-response.d.ts +12 -5
  488. package/dist/models/get-milestones-response.js +4 -4
  489. package/dist/models/get-multivariate-event-collection-lookup-history-response.d.ts +18 -0
  490. package/dist/models/get-multivariate-event-collection-lookup-history-response.js +15 -0
  491. package/dist/models/get-multivariate-event-collection-response.d.ts +5 -5
  492. package/dist/models/get-multivariate-event-collection-response.js +4 -4
  493. package/dist/models/get-multivariate-event-collections-response.d.ts +12 -5
  494. package/dist/models/get-multivariate-event-collections-response.js +4 -4
  495. package/dist/models/get-multivariate-events-response.d.ts +22 -0
  496. package/dist/models/get-multivariate-events-response.js +15 -0
  497. package/dist/models/get-order-group-response.d.ts +6 -6
  498. package/dist/models/get-order-group-response.js +4 -4
  499. package/dist/models/get-order-groups-response.d.ts +4 -5
  500. package/dist/models/get-order-groups-response.js +4 -4
  501. package/dist/models/get-order-queue-position-response.d.ts +8 -5
  502. package/dist/models/get-order-queue-position-response.js +4 -4
  503. package/dist/models/get-order-queue-positions-response.d.ts +18 -0
  504. package/dist/models/get-order-queue-positions-response.js +15 -0
  505. package/dist/models/get-order-response.d.ts +4 -4
  506. package/dist/models/get-order-response.js +4 -4
  507. package/dist/models/get-orders-response.d.ts +6 -6
  508. package/dist/models/get-orders-response.js +4 -4
  509. package/dist/models/get-portfolio-resting-order-total-value-response.d.ts +17 -0
  510. package/dist/models/get-portfolio-resting-order-total-value-response.js +15 -0
  511. package/dist/models/get-positions-response.d.ts +16 -7
  512. package/dist/models/get-positions-response.js +4 -4
  513. package/dist/models/get-quote-response.d.ts +5 -5
  514. package/dist/models/get-quote-response.js +4 -4
  515. package/dist/models/get-quotes-response.d.ts +12 -5
  516. package/dist/models/get-quotes-response.js +4 -4
  517. package/dist/models/get-rfqresponse.d.ts +5 -5
  518. package/dist/models/get-rfqresponse.js +4 -4
  519. package/dist/models/get-rfqs-response.d.ts +12 -5
  520. package/dist/models/get-rfqs-response.js +4 -4
  521. package/dist/models/get-series-fee-changes-response.d.ts +15 -0
  522. package/dist/models/get-series-fee-changes-response.js +15 -0
  523. package/dist/models/get-series-list-response.d.ts +15 -0
  524. package/dist/models/get-series-list-response.js +15 -0
  525. package/dist/models/get-series-response.d.ts +5 -5
  526. package/dist/models/get-series-response.js +4 -4
  527. package/dist/models/get-settlements-response.d.ts +5 -5
  528. package/dist/models/get-settlements-response.js +4 -4
  529. package/dist/models/get-structured-target-response.d.ts +4 -4
  530. package/dist/models/get-structured-target-response.js +4 -4
  531. package/dist/models/get-structured-targets-response.d.ts +8 -4
  532. package/dist/models/get-structured-targets-response.js +4 -4
  533. package/dist/models/get-tags-for-series-categories-response.d.ts +19 -0
  534. package/dist/models/get-tags-for-series-categories-response.js +15 -0
  535. package/dist/models/get-trades-response.d.ts +6 -6
  536. package/dist/models/get-trades-response.js +4 -4
  537. package/dist/models/get-user-data-timestamp-response.d.ts +8 -5
  538. package/dist/models/get-user-data-timestamp-response.js +4 -4
  539. package/dist/models/incentive-program.d.ts +54 -0
  540. package/dist/models/incentive-program.js +20 -0
  541. package/dist/models/index.d.ts +47 -17
  542. package/dist/models/index.js +47 -17
  543. package/dist/models/live-data.d.ts +27 -0
  544. package/dist/models/live-data.js +15 -0
  545. package/dist/models/lookup-point.d.ts +30 -0
  546. package/dist/models/lookup-point.js +15 -0
  547. package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +18 -0
  548. package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +15 -0
  549. package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +21 -0
  550. package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +15 -0
  551. package/dist/models/maintenance-window.d.ts +21 -0
  552. package/dist/models/maintenance-window.js +15 -0
  553. package/dist/models/market-candlestick.d.ts +30 -0
  554. package/dist/models/market-candlestick.js +15 -0
  555. package/dist/models/market-candlesticks-response.d.ts +22 -0
  556. package/dist/models/market-candlesticks-response.js +15 -0
  557. package/dist/models/market-metadata.d.ts +25 -0
  558. package/dist/models/market-metadata.js +15 -0
  559. package/dist/models/market-position.d.ts +61 -0
  560. package/dist/models/market-position.js +15 -0
  561. package/dist/models/market.d.ts +219 -26
  562. package/dist/models/market.js +22 -5
  563. package/dist/models/milestone.d.ts +54 -7
  564. package/dist/models/milestone.js +4 -4
  565. package/dist/models/multivariate-event-collection.d.ts +61 -9
  566. package/dist/models/multivariate-event-collection.js +4 -4
  567. package/dist/models/mve-selected-leg.d.ts +25 -0
  568. package/dist/models/mve-selected-leg.js +15 -0
  569. package/dist/models/order-group.d.ts +5 -5
  570. package/dist/models/order-group.js +4 -4
  571. package/dist/models/order-queue-position.d.ts +25 -0
  572. package/dist/models/order-queue-position.js +15 -0
  573. package/dist/models/order-status.d.ts +20 -0
  574. package/dist/models/order-status.js +24 -0
  575. package/dist/models/order.d.ts +75 -29
  576. package/dist/models/order.js +5 -11
  577. package/dist/models/orderbook.d.ts +17 -0
  578. package/dist/models/orderbook.js +15 -0
  579. package/dist/models/percentile-point.d.ts +29 -0
  580. package/dist/models/percentile-point.js +15 -0
  581. package/dist/models/price-distribution.d.ts +77 -0
  582. package/dist/models/price-distribution.js +15 -0
  583. package/dist/models/price-range.d.ts +25 -0
  584. package/dist/models/price-range.js +15 -0
  585. package/dist/models/quote.d.ts +116 -17
  586. package/dist/models/quote.js +15 -8
  587. package/dist/models/rfq.d.ts +65 -16
  588. package/dist/models/rfq.js +8 -8
  589. package/dist/models/schedule.d.ts +23 -0
  590. package/dist/models/schedule.js +15 -0
  591. package/dist/models/scope-list.d.ts +17 -0
  592. package/dist/models/scope-list.js +15 -0
  593. package/dist/models/self-trade-prevention-type.d.ts +19 -0
  594. package/dist/models/self-trade-prevention-type.js +23 -0
  595. package/dist/models/series-fee-change.d.ts +39 -0
  596. package/dist/models/series-fee-change.js +21 -0
  597. package/dist/models/series.d.ts +57 -9
  598. package/dist/models/series.js +10 -4
  599. package/dist/models/settlement-source.d.ts +21 -0
  600. package/dist/models/settlement-source.js +15 -0
  601. package/dist/models/settlement.d.ts +48 -12
  602. package/dist/models/settlement.js +9 -7
  603. package/dist/models/sport-filter-details.d.ts +24 -0
  604. package/dist/models/sport-filter-details.js +15 -0
  605. package/dist/models/structured-target.d.ts +28 -7
  606. package/dist/models/structured-target.js +4 -4
  607. package/dist/models/ticker-pair.d.ts +30 -0
  608. package/dist/models/ticker-pair.js +20 -0
  609. package/dist/models/trade.d.ts +45 -11
  610. package/dist/models/trade.js +6 -6
  611. package/dist/models/weekly-schedule.d.ts +50 -0
  612. package/dist/models/weekly-schedule.js +15 -0
  613. package/docs/AcceptQuoteRequest.md +2 -2
  614. package/docs/AmendOrderRequest.md +12 -8
  615. package/docs/AmendOrderResponse.md +3 -1
  616. package/docs/Announcement.md +6 -6
  617. package/docs/ApiKey.md +0 -2
  618. package/docs/ApiKeysApi.md +16 -106
  619. package/docs/AssociatedEvent.md +28 -0
  620. package/docs/BatchCancelOrdersIndividualResponse.md +26 -0
  621. package/docs/BatchCancelOrdersRequest.md +2 -2
  622. package/docs/BatchCancelOrdersResponse.md +2 -2
  623. package/docs/BatchCreateOrdersIndividualResponse.md +24 -0
  624. package/docs/BatchCreateOrdersResponse.md +2 -2
  625. package/docs/BatchGetMarketCandlesticksResponse.md +20 -0
  626. package/docs/BidAskDistribution.md +34 -0
  627. package/docs/CancelOrderResponse.md +2 -2
  628. package/docs/CollectionApi.md +318 -0
  629. package/docs/CommunicationsApi.md +46 -271
  630. package/docs/CreateMarketInMultivariateEventCollectionRequest.md +20 -0
  631. package/docs/CreateMarketInMultivariateEventCollectionResponse.md +22 -0
  632. package/docs/CreateOrderGroupRequest.md +1 -1
  633. package/docs/CreateOrderGroupResponse.md +1 -1
  634. package/docs/CreateOrderRequest.md +18 -6
  635. package/docs/CreateOrderResponse.md +1 -1
  636. package/docs/CreateQuoteRequest.md +7 -5
  637. package/docs/CreateQuoteResponse.md +2 -2
  638. package/docs/CreateRFQRequest.md +12 -8
  639. package/docs/CreateRFQResponse.md +2 -2
  640. package/docs/DailySchedule.md +2 -2
  641. package/docs/DecreaseOrderRequest.md +3 -1
  642. package/docs/DecreaseOrderResponse.md +1 -1
  643. package/docs/ErrorResponse.md +8 -2
  644. package/docs/EventData.md +42 -0
  645. package/docs/EventPosition.md +11 -11
  646. package/docs/EventsApi.md +133 -93
  647. package/docs/ExchangeApi.md +42 -83
  648. package/docs/ExchangeStatus.md +4 -2
  649. package/docs/FcmApi.md +92 -0
  650. package/docs/Fill.md +25 -9
  651. package/docs/ForecastPercentilesPoint.md +26 -0
  652. package/docs/GetBalanceResponse.md +5 -1
  653. package/docs/GetCommunicationsIDResponse.md +1 -1
  654. package/docs/GetEventCandlesticksResponse.md +24 -0
  655. package/docs/GetEventForecastPercentilesHistoryResponse.md +20 -0
  656. package/docs/GetEventMetadataResponse.md +12 -2
  657. package/docs/GetEventResponse.md +2 -2
  658. package/docs/GetEventsCandlesticksResponse.md +20 -0
  659. package/docs/GetEventsCandlesticksResponseEventsInner.md +26 -0
  660. package/docs/GetEventsResponse.md +4 -2
  661. package/docs/GetExchangeAnnouncementsResponse.md +1 -1
  662. package/docs/GetExchangeScheduleResponse.md +1 -1
  663. package/docs/GetFillsResponse.md +2 -2
  664. package/docs/GetFiltersBySportsResponse.md +22 -0
  665. package/docs/GetIncentiveProgramsResponse.md +22 -0
  666. package/docs/GetLiveDataResponse.md +20 -0
  667. package/docs/GetLiveDatasResponse.md +20 -0
  668. package/docs/GetMarketCandlesticksResponse.md +3 -1
  669. package/docs/GetMarketOrderbookResponse.md +1 -1
  670. package/docs/GetMarketResponse.md +1 -1
  671. package/docs/GetMarketsResponse.md +2 -2
  672. package/docs/GetMilestoneResponse.md +1 -1
  673. package/docs/GetMilestonesResponse.md +3 -1
  674. package/docs/GetMultivariateEventCollectionLookupHistoryResponse.md +20 -0
  675. package/docs/GetMultivariateEventCollectionResponse.md +2 -2
  676. package/docs/GetMultivariateEventCollectionsResponse.md +4 -2
  677. package/docs/GetMultivariateEventsResponse.md +22 -0
  678. package/docs/GetOrderGroupResponse.md +2 -2
  679. package/docs/GetOrderGroupsResponse.md +0 -2
  680. package/docs/GetOrderQueuePositionResponse.md +1 -1
  681. package/docs/GetOrderQueuePositionsResponse.md +20 -0
  682. package/docs/GetOrdersResponse.md +2 -2
  683. package/docs/GetPortfolioRestingOrderTotalValueResponse.md +20 -0
  684. package/docs/GetPositionsResponse.md +4 -4
  685. package/docs/GetQuoteResponse.md +1 -1
  686. package/docs/GetQuotesResponse.md +3 -1
  687. package/docs/GetRFQResponse.md +1 -1
  688. package/docs/GetRFQsResponse.md +3 -1
  689. package/docs/GetSeriesFeeChangesResponse.md +20 -0
  690. package/docs/GetSeriesListResponse.md +20 -0
  691. package/docs/GetSeriesResponse.md +1 -1
  692. package/docs/GetSettlementsResponse.md +1 -1
  693. package/docs/GetStructuredTargetsResponse.md +2 -0
  694. package/docs/GetTagsForSeriesCategoriesResponse.md +20 -0
  695. package/docs/GetTradesResponse.md +2 -2
  696. package/docs/GetUserDataTimestampResponse.md +2 -2
  697. package/docs/IncentiveProgram.md +36 -0
  698. package/docs/IncentiveProgramsApi.md +44 -0
  699. package/docs/LiveData.md +24 -0
  700. package/docs/LiveDataApi.md +75 -0
  701. package/docs/LookupPoint.md +26 -0
  702. package/docs/LookupTickersForMarketInMultivariateEventCollectionRequest.md +20 -0
  703. package/docs/LookupTickersForMarketInMultivariateEventCollectionResponse.md +22 -0
  704. package/docs/MaintenanceWindow.md +22 -0
  705. package/docs/Market.md +105 -21
  706. package/docs/MarketApi.md +311 -0
  707. package/docs/MarketCandlestick.md +30 -0
  708. package/docs/MarketCandlesticksResponse.md +22 -0
  709. package/docs/MarketMetadata.md +24 -0
  710. package/docs/MarketPosition.md +42 -0
  711. package/docs/MarketsApi.md +3 -4
  712. package/docs/Milestone.md +23 -5
  713. package/docs/MilestoneApi.md +85 -0
  714. package/docs/MilestonesApi.md +0 -1
  715. package/docs/MultivariateApi.md +188 -0
  716. package/docs/MultivariateCollectionsApi.md +0 -1
  717. package/docs/MultivariateEventCollection.md +26 -6
  718. package/docs/MveSelectedLeg.md +24 -0
  719. package/docs/Order.md +42 -18
  720. package/docs/OrderGroup.md +1 -1
  721. package/docs/OrderGroupsApi.md +180 -0
  722. package/docs/OrderQueuePosition.md +24 -0
  723. package/docs/OrderStatus.md +13 -0
  724. package/docs/Orderbook.md +26 -0
  725. package/docs/OrdersApi.md +372 -0
  726. package/docs/PercentilePoint.md +26 -0
  727. package/docs/PortfolioApi.md +27 -1062
  728. package/docs/PriceDistribution.md +50 -0
  729. package/docs/PriceRange.md +24 -0
  730. package/docs/Quote.md +48 -16
  731. package/docs/RFQ.md +26 -14
  732. package/docs/Schedule.md +22 -0
  733. package/docs/ScopeList.md +20 -0
  734. package/docs/SearchApi.md +69 -0
  735. package/docs/SelfTradePreventionType.md +11 -0
  736. package/docs/Series.md +21 -5
  737. package/docs/SeriesApi.md +0 -1
  738. package/docs/SeriesFeeChange.md +28 -0
  739. package/docs/Settlement.md +15 -7
  740. package/docs/SettlementSource.md +22 -0
  741. package/docs/SportFilterDetails.md +22 -0
  742. package/docs/StructuredTarget.md +12 -6
  743. package/docs/StructuredTargetsApi.md +11 -57
  744. package/docs/TickerPair.md +24 -0
  745. package/docs/Trade.md +14 -6
  746. package/docs/WeeklySchedule.md +36 -0
  747. package/index.ts +4 -4
  748. package/models/accept-quote-request.ts +16 -5
  749. package/models/amend-order-request.ts +27 -10
  750. package/models/amend-order-response.ts +6 -5
  751. package/models/announcement.ts +26 -14
  752. package/models/api-key.ts +4 -8
  753. package/models/associated-event.ts +39 -0
  754. package/models/batch-cancel-orders-individual-response.ts +35 -0
  755. package/models/batch-cancel-orders-request.ts +8 -5
  756. package/models/batch-cancel-orders-response-responses-inner.ts +0 -1
  757. package/models/batch-cancel-orders-response.ts +6 -6
  758. package/models/batch-create-orders-individual-response.ts +28 -0
  759. package/models/batch-create-orders-request.ts +4 -4
  760. package/models/batch-create-orders-response-responses-inner.ts +0 -1
  761. package/models/batch-create-orders-response.ts +6 -6
  762. package/models/batch-get-market-candlesticks-response.ts +26 -0
  763. package/models/bid-ask-distribution.ts +51 -0
  764. package/models/cancel-order-response.ts +6 -6
  765. package/models/candlestick.ts +0 -1
  766. package/models/create-api-key-request.ts +4 -4
  767. package/models/create-api-key-response.ts +4 -4
  768. package/models/create-market-in-multivariate-event-collection-request.ts +26 -0
  769. package/models/create-market-in-multivariate-event-collection-response.ts +27 -0
  770. package/models/create-order-group-request.ts +5 -5
  771. package/models/create-order-group-response.ts +5 -5
  772. package/models/create-order-request.ts +37 -9
  773. package/models/create-order-response.ts +5 -5
  774. package/models/create-quote-request.ts +19 -6
  775. package/models/create-quote-response.ts +8 -8
  776. package/models/create-rfqrequest.ts +28 -16
  777. package/models/create-rfqresponse.ts +8 -8
  778. package/models/daily-schedule.ts +12 -6
  779. package/models/decrease-order-request.ts +6 -5
  780. package/models/decrease-order-response.ts +5 -5
  781. package/models/error-response-error.ts +0 -1
  782. package/models/error-response.ts +20 -8
  783. package/models/event-data.ts +70 -0
  784. package/models/event-position.ts +24 -24
  785. package/models/event.ts +0 -2
  786. package/models/exchange-status.ts +16 -6
  787. package/models/fill.ts +71 -12
  788. package/models/forecast-percentiles-point.ts +38 -0
  789. package/models/generate-api-key-request.ts +4 -4
  790. package/models/generate-api-key-response.ts +4 -4
  791. package/models/get-api-keys-response.ts +4 -4
  792. package/models/get-balance-response.ts +14 -6
  793. package/models/get-communications-idresponse.ts +6 -6
  794. package/models/get-event-candlesticks-response.ts +34 -0
  795. package/models/get-event-forecast-percentiles-history-response.ts +26 -0
  796. package/models/get-event-metadata-response.ts +34 -5
  797. package/models/get-event-response.ts +10 -7
  798. package/models/get-events-candlesticks-response-events-inner.ts +38 -0
  799. package/models/get-events-candlesticks-response.ts +26 -0
  800. package/models/get-events-response.ts +20 -7
  801. package/models/get-exchange-announcements-response.ts +8 -5
  802. package/models/get-exchange-schedule-response-schedule.ts +0 -1
  803. package/models/get-exchange-schedule-response.ts +6 -6
  804. package/models/get-fills-response.ts +6 -6
  805. package/models/get-filters-by-sports-response.ts +30 -0
  806. package/models/get-incentive-programs-response.ts +27 -0
  807. package/models/get-live-data-response.ts +23 -0
  808. package/models/get-live-datas-response.ts +23 -0
  809. package/models/get-market-candlesticks-response.ts +13 -6
  810. package/models/get-market-orderbook-response-orderbook.ts +0 -1
  811. package/models/get-market-orderbook-response.ts +6 -6
  812. package/models/get-market-response.ts +5 -5
  813. package/models/get-markets-response.ts +6 -6
  814. package/models/get-milestone-response.ts +5 -5
  815. package/models/get-milestones-response.ts +12 -5
  816. package/models/get-multivariate-event-collection-lookup-history-response.ts +26 -0
  817. package/models/get-multivariate-event-collection-response.ts +5 -5
  818. package/models/get-multivariate-event-collections-response.ts +12 -5
  819. package/models/get-multivariate-events-response.ts +30 -0
  820. package/models/get-order-group-response.ts +6 -6
  821. package/models/get-order-groups-response.ts +4 -5
  822. package/models/get-order-queue-position-response.ts +8 -5
  823. package/models/get-order-queue-positions-response.ts +26 -0
  824. package/models/get-order-response.ts +4 -4
  825. package/models/get-orders-response.ts +6 -6
  826. package/models/get-portfolio-resting-order-total-value-response.ts +23 -0
  827. package/models/get-positions-response.ts +16 -7
  828. package/models/get-queue-positions-request.ts +0 -1
  829. package/models/get-queue-positions-response.ts +0 -1
  830. package/models/get-quote-response.ts +5 -5
  831. package/models/get-quotes-response.ts +12 -5
  832. package/models/get-rfqresponse.ts +5 -5
  833. package/models/get-rfqs-response.ts +12 -5
  834. package/models/get-series-by-ticker-response.ts +0 -1
  835. package/models/get-series-fee-changes-response.ts +23 -0
  836. package/models/get-series-list-response.ts +23 -0
  837. package/models/get-series-response.ts +5 -5
  838. package/models/get-settlements-response.ts +5 -5
  839. package/models/get-structured-target-response.ts +4 -4
  840. package/models/get-structured-targets-response.ts +8 -4
  841. package/models/get-tags-for-series-categories-response.ts +23 -0
  842. package/models/get-total-resting-order-value-response.ts +0 -1
  843. package/models/get-trades-response.ts +6 -6
  844. package/models/get-user-data-timestamp-response.ts +8 -5
  845. package/models/incentive-program.ts +63 -0
  846. package/models/index.ts +47 -17
  847. package/models/live-data.ts +31 -0
  848. package/models/lookup-bundle-request-bundle-inner.ts +0 -1
  849. package/models/lookup-bundle-request.ts +0 -1
  850. package/models/lookup-bundle-response.ts +0 -1
  851. package/models/lookup-point.ts +38 -0
  852. package/models/lookup-tickers-for-market-in-multivariate-event-collection-request.ts +26 -0
  853. package/models/lookup-tickers-for-market-in-multivariate-event-collection-response.ts +27 -0
  854. package/models/maintenance-window.ts +27 -0
  855. package/models/market-candlestick.ts +40 -0
  856. package/models/market-candlesticks-response.ts +30 -0
  857. package/models/market-metadata.ts +31 -0
  858. package/models/market-position.ts +67 -0
  859. package/models/market.ts +226 -26
  860. package/models/milestone.ts +52 -7
  861. package/models/multivariate-event-collection-events-inner.ts +0 -1
  862. package/models/multivariate-event-collection.ts +61 -9
  863. package/models/mve-selected-leg.ts +31 -0
  864. package/models/order-group.ts +5 -5
  865. package/models/order-queue-position.ts +31 -0
  866. package/models/order-status.ts +30 -0
  867. package/models/order.ts +79 -30
  868. package/models/orderbook-level.ts +0 -1
  869. package/models/orderbook.ts +23 -0
  870. package/models/percentile-point.ts +35 -0
  871. package/models/position.ts +0 -2
  872. package/models/price-distribution.ts +83 -0
  873. package/models/price-range.ts +31 -0
  874. package/models/quote.ts +117 -17
  875. package/models/rfq.ts +67 -16
  876. package/models/schedule.ts +33 -0
  877. package/models/scope-list.ts +23 -0
  878. package/models/self-trade-prevention-type.ts +29 -0
  879. package/models/series-fee-change.ts +48 -0
  880. package/models/series.ts +62 -9
  881. package/models/settlement-source.ts +27 -0
  882. package/models/settlement.ts +49 -13
  883. package/models/sport-filter-details.ts +30 -0
  884. package/models/structured-target.ts +28 -7
  885. package/models/ticker-pair.ts +39 -0
  886. package/models/trade.ts +45 -11
  887. package/models/weekly-schedule.ts +58 -0
  888. package/package.json +1 -1
@@ -1,11 +1,11 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Kalshi Trading API
5
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
4
+ * Kalshi Trade API Manual Endpoints
5
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
6
+ *
7
+ * The version of the OpenAPI document: 3.0.0
6
8
  *
7
- * The version of the OpenAPI document: 2.0.0
8
- * Contact: support@kalshi.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -26,16 +26,16 @@ import globalAxios from 'axios';
26
26
  import { URL } from 'url';
27
27
  // Some imports not used depending on template conditions
28
28
  // @ts-ignore
29
- import { DUMMY_BASE_URL, assertParamExists, setBearerAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
29
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
30
30
  // @ts-ignore
31
- import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
31
+ import { BASE_PATH, BaseAPI } from '../base';
32
32
  /**
33
33
  * EventsApi - axios parameter creator
34
34
  */
35
35
  export const EventsApiAxiosParamCreator = function (configuration) {
36
36
  return {
37
37
  /**
38
- * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
38
+ * Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
39
39
  * @summary Get Event
40
40
  * @param {string} eventTicker Event ticker
41
41
  * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
@@ -56,9 +56,6 @@ export const EventsApiAxiosParamCreator = function (configuration) {
56
56
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
57
57
  const localVarHeaderParameter = {};
58
58
  const localVarQueryParameter = {};
59
- // authentication bearerAuth required
60
- // http bearer authentication required
61
- yield setBearerAuthToObject(localVarHeaderParameter, configuration);
62
59
  if (withNestedMarkets !== undefined) {
63
60
  localVarQueryParameter['with_nested_markets'] = withNestedMarkets;
64
61
  }
@@ -71,7 +68,70 @@ export const EventsApiAxiosParamCreator = function (configuration) {
71
68
  };
72
69
  }),
73
70
  /**
74
- * Get metadata about an event by its ticker
71
+ * Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
72
+ * @summary Get Event Forecast Percentile History
73
+ * @param {string} ticker The event ticker
74
+ * @param {string} seriesTicker The series ticker
75
+ * @param {Array<number>} percentiles Array of percentile values to retrieve (0-10000, max 10 values)
76
+ * @param {number} startTs Start timestamp for the range
77
+ * @param {number} endTs End timestamp for the range
78
+ * @param {GetEventForecastPercentilesHistoryPeriodIntervalEnum} periodInterval Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals.
79
+ * @param {*} [options] Override http request option.
80
+ * @throws {RequiredError}
81
+ */
82
+ getEventForecastPercentilesHistory: (ticker_1, seriesTicker_1, percentiles_1, startTs_1, endTs_1, periodInterval_1, ...args_1) => __awaiter(this, [ticker_1, seriesTicker_1, percentiles_1, startTs_1, endTs_1, periodInterval_1, ...args_1], void 0, function* (ticker, seriesTicker, percentiles, startTs, endTs, periodInterval, options = {}) {
83
+ // verify required parameter 'ticker' is not null or undefined
84
+ assertParamExists('getEventForecastPercentilesHistory', 'ticker', ticker);
85
+ // verify required parameter 'seriesTicker' is not null or undefined
86
+ assertParamExists('getEventForecastPercentilesHistory', 'seriesTicker', seriesTicker);
87
+ // verify required parameter 'percentiles' is not null or undefined
88
+ assertParamExists('getEventForecastPercentilesHistory', 'percentiles', percentiles);
89
+ // verify required parameter 'startTs' is not null or undefined
90
+ assertParamExists('getEventForecastPercentilesHistory', 'startTs', startTs);
91
+ // verify required parameter 'endTs' is not null or undefined
92
+ assertParamExists('getEventForecastPercentilesHistory', 'endTs', endTs);
93
+ // verify required parameter 'periodInterval' is not null or undefined
94
+ assertParamExists('getEventForecastPercentilesHistory', 'periodInterval', periodInterval);
95
+ const localVarPath = `/series/{series_ticker}/events/{ticker}/forecast_percentile_history`
96
+ .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker)))
97
+ .replace(`{${"series_ticker"}}`, encodeURIComponent(String(seriesTicker)));
98
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
99
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
100
+ let baseOptions;
101
+ if (configuration) {
102
+ baseOptions = configuration.baseOptions;
103
+ }
104
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
105
+ const localVarHeaderParameter = {};
106
+ const localVarQueryParameter = {};
107
+ // authentication kalshiAccessSignature required
108
+ yield setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
109
+ // authentication kalshiAccessKey required
110
+ yield setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
111
+ // authentication kalshiAccessTimestamp required
112
+ yield setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
113
+ if (percentiles) {
114
+ localVarQueryParameter['percentiles'] = percentiles;
115
+ }
116
+ if (startTs !== undefined) {
117
+ localVarQueryParameter['start_ts'] = startTs;
118
+ }
119
+ if (endTs !== undefined) {
120
+ localVarQueryParameter['end_ts'] = endTs;
121
+ }
122
+ if (periodInterval !== undefined) {
123
+ localVarQueryParameter['period_interval'] = periodInterval;
124
+ }
125
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
126
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
127
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
128
+ return {
129
+ url: toPathString(localVarUrlObj),
130
+ options: localVarRequestOptions,
131
+ };
132
+ }),
133
+ /**
134
+ * Endpoint for getting metadata about an event by its ticker. Returns only the metadata information for an event.
75
135
  * @summary Get Event Metadata
76
136
  * @param {string} eventTicker Event ticker
77
137
  * @param {*} [options] Override http request option.
@@ -91,9 +151,6 @@ export const EventsApiAxiosParamCreator = function (configuration) {
91
151
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
92
152
  const localVarHeaderParameter = {};
93
153
  const localVarQueryParameter = {};
94
- // authentication bearerAuth required
95
- // http bearer authentication required
96
- yield setBearerAuthToObject(localVarHeaderParameter, configuration);
97
154
  setSearchParams(localVarUrlObj, localVarQueryParameter);
98
155
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
99
156
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -103,18 +160,19 @@ export const EventsApiAxiosParamCreator = function (configuration) {
103
160
  };
104
161
  }),
105
162
  /**
106
- * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
163
+ * Filter by event status. Possible values: \'open\', \'closed\', \'settled\'. Leave empty to return events with any status.
107
164
  * @summary Get Events
108
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
109
- * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
110
- * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
111
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
165
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
166
+ * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
167
+ * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
168
+ * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
169
+ * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \&#39;open\&#39;, \&#39;closed\&#39;, \&#39;settled\&#39;. Leave empty to return events with any status.
112
170
  * @param {string} [seriesTicker] Filter by series ticker
113
- * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
171
+ * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
114
172
  * @param {*} [options] Override http request option.
115
173
  * @throws {RequiredError}
116
174
  */
117
- getEvents: (limit_1, cursor_1, withNestedMarkets_1, status_1, seriesTicker_1, minCloseTs_1, ...args_1) => __awaiter(this, [limit_1, cursor_1, withNestedMarkets_1, status_1, seriesTicker_1, minCloseTs_1, ...args_1], void 0, function* (limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options = {}) {
175
+ getEvents: (limit_1, cursor_1, withNestedMarkets_1, withMilestones_1, status_1, seriesTicker_1, minCloseTs_1, ...args_1) => __awaiter(this, [limit_1, cursor_1, withNestedMarkets_1, withMilestones_1, status_1, seriesTicker_1, minCloseTs_1, ...args_1], void 0, function* (limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options = {}) {
118
176
  const localVarPath = `/events`;
119
177
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
120
178
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -125,9 +183,6 @@ export const EventsApiAxiosParamCreator = function (configuration) {
125
183
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
126
184
  const localVarHeaderParameter = {};
127
185
  const localVarQueryParameter = {};
128
- // authentication bearerAuth required
129
- // http bearer authentication required
130
- yield setBearerAuthToObject(localVarHeaderParameter, configuration);
131
186
  if (limit !== undefined) {
132
187
  localVarQueryParameter['limit'] = limit;
133
188
  }
@@ -137,6 +192,9 @@ export const EventsApiAxiosParamCreator = function (configuration) {
137
192
  if (withNestedMarkets !== undefined) {
138
193
  localVarQueryParameter['with_nested_markets'] = withNestedMarkets;
139
194
  }
195
+ if (withMilestones !== undefined) {
196
+ localVarQueryParameter['with_milestones'] = withMilestones;
197
+ }
140
198
  if (status !== undefined) {
141
199
  localVarQueryParameter['status'] = status;
142
200
  }
@@ -154,6 +212,102 @@ export const EventsApiAxiosParamCreator = function (configuration) {
154
212
  options: localVarRequestOptions,
155
213
  };
156
214
  }),
215
+ /**
216
+ * End-point for returning aggregated data across all markets corresponding to an event.
217
+ * @summary Get Event Candlesticks
218
+ * @param {string} ticker The event ticker
219
+ * @param {string} seriesTicker The series ticker
220
+ * @param {number} startTs Start timestamp for the range
221
+ * @param {number} endTs End timestamp for the range
222
+ * @param {GetMarketCandlesticksByEventPeriodIntervalEnum} periodInterval Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day.
223
+ * @param {*} [options] Override http request option.
224
+ * @throws {RequiredError}
225
+ */
226
+ getMarketCandlesticksByEvent: (ticker_1, seriesTicker_1, startTs_1, endTs_1, periodInterval_1, ...args_1) => __awaiter(this, [ticker_1, seriesTicker_1, startTs_1, endTs_1, periodInterval_1, ...args_1], void 0, function* (ticker, seriesTicker, startTs, endTs, periodInterval, options = {}) {
227
+ // verify required parameter 'ticker' is not null or undefined
228
+ assertParamExists('getMarketCandlesticksByEvent', 'ticker', ticker);
229
+ // verify required parameter 'seriesTicker' is not null or undefined
230
+ assertParamExists('getMarketCandlesticksByEvent', 'seriesTicker', seriesTicker);
231
+ // verify required parameter 'startTs' is not null or undefined
232
+ assertParamExists('getMarketCandlesticksByEvent', 'startTs', startTs);
233
+ // verify required parameter 'endTs' is not null or undefined
234
+ assertParamExists('getMarketCandlesticksByEvent', 'endTs', endTs);
235
+ // verify required parameter 'periodInterval' is not null or undefined
236
+ assertParamExists('getMarketCandlesticksByEvent', 'periodInterval', periodInterval);
237
+ const localVarPath = `/series/{series_ticker}/events/{ticker}/candlesticks`
238
+ .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker)))
239
+ .replace(`{${"series_ticker"}}`, encodeURIComponent(String(seriesTicker)));
240
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
241
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
242
+ let baseOptions;
243
+ if (configuration) {
244
+ baseOptions = configuration.baseOptions;
245
+ }
246
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
247
+ const localVarHeaderParameter = {};
248
+ const localVarQueryParameter = {};
249
+ if (startTs !== undefined) {
250
+ localVarQueryParameter['start_ts'] = startTs;
251
+ }
252
+ if (endTs !== undefined) {
253
+ localVarQueryParameter['end_ts'] = endTs;
254
+ }
255
+ if (periodInterval !== undefined) {
256
+ localVarQueryParameter['period_interval'] = periodInterval;
257
+ }
258
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
259
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
260
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
261
+ return {
262
+ url: toPathString(localVarUrlObj),
263
+ options: localVarRequestOptions,
264
+ };
265
+ }),
266
+ /**
267
+ * Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker.
268
+ * @summary Get Multivariate Events
269
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
270
+ * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results.
271
+ * @param {string} [seriesTicker] Filter by series ticker
272
+ * @param {string} [collectionTicker] Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker.
273
+ * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
274
+ * @param {*} [options] Override http request option.
275
+ * @throws {RequiredError}
276
+ */
277
+ getMultivariateEvents: (limit_1, cursor_1, seriesTicker_1, collectionTicker_1, withNestedMarkets_1, ...args_1) => __awaiter(this, [limit_1, cursor_1, seriesTicker_1, collectionTicker_1, withNestedMarkets_1, ...args_1], void 0, function* (limit, cursor, seriesTicker, collectionTicker, withNestedMarkets, options = {}) {
278
+ const localVarPath = `/events/multivariate`;
279
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
280
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
281
+ let baseOptions;
282
+ if (configuration) {
283
+ baseOptions = configuration.baseOptions;
284
+ }
285
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
286
+ const localVarHeaderParameter = {};
287
+ const localVarQueryParameter = {};
288
+ if (limit !== undefined) {
289
+ localVarQueryParameter['limit'] = limit;
290
+ }
291
+ if (cursor !== undefined) {
292
+ localVarQueryParameter['cursor'] = cursor;
293
+ }
294
+ if (seriesTicker !== undefined) {
295
+ localVarQueryParameter['series_ticker'] = seriesTicker;
296
+ }
297
+ if (collectionTicker !== undefined) {
298
+ localVarQueryParameter['collection_ticker'] = collectionTicker;
299
+ }
300
+ if (withNestedMarkets !== undefined) {
301
+ localVarQueryParameter['with_nested_markets'] = withNestedMarkets;
302
+ }
303
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
304
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
305
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
306
+ return {
307
+ url: toPathString(localVarUrlObj),
308
+ options: localVarRequestOptions,
309
+ };
310
+ }),
157
311
  };
158
312
  };
159
313
  /**
@@ -163,7 +317,7 @@ export const EventsApiFp = function (configuration) {
163
317
  const localVarAxiosParamCreator = EventsApiAxiosParamCreator(configuration);
164
318
  return {
165
319
  /**
166
- * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
320
+ * Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
167
321
  * @summary Get Event
168
322
  * @param {string} eventTicker Event ticker
169
323
  * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
@@ -172,15 +326,36 @@ export const EventsApiFp = function (configuration) {
172
326
  */
173
327
  getEvent(eventTicker, withNestedMarkets, options) {
174
328
  return __awaiter(this, void 0, void 0, function* () {
175
- var _a, _b, _c;
329
+ var _a;
176
330
  const localVarAxiosArgs = yield localVarAxiosParamCreator.getEvent(eventTicker, withNestedMarkets, options);
177
331
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
178
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsApi.getEvent']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
332
+ const localVarOperationServerBasePath = undefined;
333
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
334
+ });
335
+ },
336
+ /**
337
+ * Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
338
+ * @summary Get Event Forecast Percentile History
339
+ * @param {string} ticker The event ticker
340
+ * @param {string} seriesTicker The series ticker
341
+ * @param {Array<number>} percentiles Array of percentile values to retrieve (0-10000, max 10 values)
342
+ * @param {number} startTs Start timestamp for the range
343
+ * @param {number} endTs End timestamp for the range
344
+ * @param {GetEventForecastPercentilesHistoryPeriodIntervalEnum} periodInterval Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals.
345
+ * @param {*} [options] Override http request option.
346
+ * @throws {RequiredError}
347
+ */
348
+ getEventForecastPercentilesHistory(ticker, seriesTicker, percentiles, startTs, endTs, periodInterval, options) {
349
+ return __awaiter(this, void 0, void 0, function* () {
350
+ var _a;
351
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventForecastPercentilesHistory(ticker, seriesTicker, percentiles, startTs, endTs, periodInterval, options);
352
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
353
+ const localVarOperationServerBasePath = undefined;
179
354
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
180
355
  });
181
356
  },
182
357
  /**
183
- * Get metadata about an event by its ticker
358
+ * Endpoint for getting metadata about an event by its ticker. Returns only the metadata information for an event.
184
359
  * @summary Get Event Metadata
185
360
  * @param {string} eventTicker Event ticker
186
361
  * @param {*} [options] Override http request option.
@@ -188,31 +363,72 @@ export const EventsApiFp = function (configuration) {
188
363
  */
189
364
  getEventMetadata(eventTicker, options) {
190
365
  return __awaiter(this, void 0, void 0, function* () {
191
- var _a, _b, _c;
366
+ var _a;
192
367
  const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventMetadata(eventTicker, options);
193
368
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
194
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsApi.getEventMetadata']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
369
+ const localVarOperationServerBasePath = undefined;
195
370
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
196
371
  });
197
372
  },
198
373
  /**
199
- * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
374
+ * Filter by event status. Possible values: \'open\', \'closed\', \'settled\'. Leave empty to return events with any status.
200
375
  * @summary Get Events
376
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
377
+ * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
378
+ * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
379
+ * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
380
+ * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \&#39;open\&#39;, \&#39;closed\&#39;, \&#39;settled\&#39;. Leave empty to return events with any status.
381
+ * @param {string} [seriesTicker] Filter by series ticker
382
+ * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
383
+ * @param {*} [options] Override http request option.
384
+ * @throws {RequiredError}
385
+ */
386
+ getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options) {
387
+ return __awaiter(this, void 0, void 0, function* () {
388
+ var _a;
389
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options);
390
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
391
+ const localVarOperationServerBasePath = undefined;
392
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
393
+ });
394
+ },
395
+ /**
396
+ * End-point for returning aggregated data across all markets corresponding to an event.
397
+ * @summary Get Event Candlesticks
398
+ * @param {string} ticker The event ticker
399
+ * @param {string} seriesTicker The series ticker
400
+ * @param {number} startTs Start timestamp for the range
401
+ * @param {number} endTs End timestamp for the range
402
+ * @param {GetMarketCandlesticksByEventPeriodIntervalEnum} periodInterval Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day.
403
+ * @param {*} [options] Override http request option.
404
+ * @throws {RequiredError}
405
+ */
406
+ getMarketCandlesticksByEvent(ticker, seriesTicker, startTs, endTs, periodInterval, options) {
407
+ return __awaiter(this, void 0, void 0, function* () {
408
+ var _a;
409
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarketCandlesticksByEvent(ticker, seriesTicker, startTs, endTs, periodInterval, options);
410
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
411
+ const localVarOperationServerBasePath = undefined;
412
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
413
+ });
414
+ },
415
+ /**
416
+ * Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker.
417
+ * @summary Get Multivariate Events
201
418
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
202
- * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
203
- * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
204
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
419
+ * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results.
205
420
  * @param {string} [seriesTicker] Filter by series ticker
206
- * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
421
+ * @param {string} [collectionTicker] Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker.
422
+ * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
207
423
  * @param {*} [options] Override http request option.
208
424
  * @throws {RequiredError}
209
425
  */
210
- getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options) {
426
+ getMultivariateEvents(limit, cursor, seriesTicker, collectionTicker, withNestedMarkets, options) {
211
427
  return __awaiter(this, void 0, void 0, function* () {
212
- var _a, _b, _c;
213
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options);
428
+ var _a;
429
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMultivariateEvents(limit, cursor, seriesTicker, collectionTicker, withNestedMarkets, options);
214
430
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
215
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsApi.getEvents']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
431
+ const localVarOperationServerBasePath = undefined;
216
432
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
217
433
  });
218
434
  },
@@ -225,7 +441,7 @@ export const EventsApiFactory = function (configuration, basePath, axios) {
225
441
  const localVarFp = EventsApiFp(configuration);
226
442
  return {
227
443
  /**
228
- * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
444
+ * Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
229
445
  * @summary Get Event
230
446
  * @param {string} eventTicker Event ticker
231
447
  * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
@@ -236,7 +452,22 @@ export const EventsApiFactory = function (configuration, basePath, axios) {
236
452
  return localVarFp.getEvent(eventTicker, withNestedMarkets, options).then((request) => request(axios, basePath));
237
453
  },
238
454
  /**
239
- * Get metadata about an event by its ticker
455
+ * Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
456
+ * @summary Get Event Forecast Percentile History
457
+ * @param {string} ticker The event ticker
458
+ * @param {string} seriesTicker The series ticker
459
+ * @param {Array<number>} percentiles Array of percentile values to retrieve (0-10000, max 10 values)
460
+ * @param {number} startTs Start timestamp for the range
461
+ * @param {number} endTs End timestamp for the range
462
+ * @param {GetEventForecastPercentilesHistoryPeriodIntervalEnum} periodInterval Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals.
463
+ * @param {*} [options] Override http request option.
464
+ * @throws {RequiredError}
465
+ */
466
+ getEventForecastPercentilesHistory(ticker, seriesTicker, percentiles, startTs, endTs, periodInterval, options) {
467
+ return localVarFp.getEventForecastPercentilesHistory(ticker, seriesTicker, percentiles, startTs, endTs, periodInterval, options).then((request) => request(axios, basePath));
468
+ },
469
+ /**
470
+ * Endpoint for getting metadata about an event by its ticker. Returns only the metadata information for an event.
240
471
  * @summary Get Event Metadata
241
472
  * @param {string} eventTicker Event ticker
242
473
  * @param {*} [options] Override http request option.
@@ -246,19 +477,48 @@ export const EventsApiFactory = function (configuration, basePath, axios) {
246
477
  return localVarFp.getEventMetadata(eventTicker, options).then((request) => request(axios, basePath));
247
478
  },
248
479
  /**
249
- * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
480
+ * Filter by event status. Possible values: \'open\', \'closed\', \'settled\'. Leave empty to return events with any status.
250
481
  * @summary Get Events
482
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
483
+ * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
484
+ * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
485
+ * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
486
+ * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \&#39;open\&#39;, \&#39;closed\&#39;, \&#39;settled\&#39;. Leave empty to return events with any status.
487
+ * @param {string} [seriesTicker] Filter by series ticker
488
+ * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
489
+ * @param {*} [options] Override http request option.
490
+ * @throws {RequiredError}
491
+ */
492
+ getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options) {
493
+ return localVarFp.getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options).then((request) => request(axios, basePath));
494
+ },
495
+ /**
496
+ * End-point for returning aggregated data across all markets corresponding to an event.
497
+ * @summary Get Event Candlesticks
498
+ * @param {string} ticker The event ticker
499
+ * @param {string} seriesTicker The series ticker
500
+ * @param {number} startTs Start timestamp for the range
501
+ * @param {number} endTs End timestamp for the range
502
+ * @param {GetMarketCandlesticksByEventPeriodIntervalEnum} periodInterval Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day.
503
+ * @param {*} [options] Override http request option.
504
+ * @throws {RequiredError}
505
+ */
506
+ getMarketCandlesticksByEvent(ticker, seriesTicker, startTs, endTs, periodInterval, options) {
507
+ return localVarFp.getMarketCandlesticksByEvent(ticker, seriesTicker, startTs, endTs, periodInterval, options).then((request) => request(axios, basePath));
508
+ },
509
+ /**
510
+ * Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker.
511
+ * @summary Get Multivariate Events
251
512
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
252
- * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
253
- * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
254
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
513
+ * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results.
255
514
  * @param {string} [seriesTicker] Filter by series ticker
256
- * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
515
+ * @param {string} [collectionTicker] Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker.
516
+ * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
257
517
  * @param {*} [options] Override http request option.
258
518
  * @throws {RequiredError}
259
519
  */
260
- getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options) {
261
- return localVarFp.getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options).then((request) => request(axios, basePath));
520
+ getMultivariateEvents(limit, cursor, seriesTicker, collectionTicker, withNestedMarkets, options) {
521
+ return localVarFp.getMultivariateEvents(limit, cursor, seriesTicker, collectionTicker, withNestedMarkets, options).then((request) => request(axios, basePath));
262
522
  },
263
523
  };
264
524
  };
@@ -267,7 +527,7 @@ export const EventsApiFactory = function (configuration, basePath, axios) {
267
527
  */
268
528
  export class EventsApi extends BaseAPI {
269
529
  /**
270
- * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
530
+ * Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
271
531
  * @summary Get Event
272
532
  * @param {string} eventTicker Event ticker
273
533
  * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
@@ -278,7 +538,22 @@ export class EventsApi extends BaseAPI {
278
538
  return EventsApiFp(this.configuration).getEvent(eventTicker, withNestedMarkets, options).then((request) => request(this.axios, this.basePath));
279
539
  }
280
540
  /**
281
- * Get metadata about an event by its ticker
541
+ * Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
542
+ * @summary Get Event Forecast Percentile History
543
+ * @param {string} ticker The event ticker
544
+ * @param {string} seriesTicker The series ticker
545
+ * @param {Array<number>} percentiles Array of percentile values to retrieve (0-10000, max 10 values)
546
+ * @param {number} startTs Start timestamp for the range
547
+ * @param {number} endTs End timestamp for the range
548
+ * @param {GetEventForecastPercentilesHistoryPeriodIntervalEnum} periodInterval Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals.
549
+ * @param {*} [options] Override http request option.
550
+ * @throws {RequiredError}
551
+ */
552
+ getEventForecastPercentilesHistory(ticker, seriesTicker, percentiles, startTs, endTs, periodInterval, options) {
553
+ return EventsApiFp(this.configuration).getEventForecastPercentilesHistory(ticker, seriesTicker, percentiles, startTs, endTs, periodInterval, options).then((request) => request(this.axios, this.basePath));
554
+ }
555
+ /**
556
+ * Endpoint for getting metadata about an event by its ticker. Returns only the metadata information for an event.
282
557
  * @summary Get Event Metadata
283
558
  * @param {string} eventTicker Event ticker
284
559
  * @param {*} [options] Override http request option.
@@ -288,18 +563,63 @@ export class EventsApi extends BaseAPI {
288
563
  return EventsApiFp(this.configuration).getEventMetadata(eventTicker, options).then((request) => request(this.axios, this.basePath));
289
564
  }
290
565
  /**
291
- * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
566
+ * Filter by event status. Possible values: \'open\', \'closed\', \'settled\'. Leave empty to return events with any status.
292
567
  * @summary Get Events
568
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
569
+ * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
570
+ * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
571
+ * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
572
+ * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \&#39;open\&#39;, \&#39;closed\&#39;, \&#39;settled\&#39;. Leave empty to return events with any status.
573
+ * @param {string} [seriesTicker] Filter by series ticker
574
+ * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
575
+ * @param {*} [options] Override http request option.
576
+ * @throws {RequiredError}
577
+ */
578
+ getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options) {
579
+ return EventsApiFp(this.configuration).getEvents(limit, cursor, withNestedMarkets, withMilestones, status, seriesTicker, minCloseTs, options).then((request) => request(this.axios, this.basePath));
580
+ }
581
+ /**
582
+ * End-point for returning aggregated data across all markets corresponding to an event.
583
+ * @summary Get Event Candlesticks
584
+ * @param {string} ticker The event ticker
585
+ * @param {string} seriesTicker The series ticker
586
+ * @param {number} startTs Start timestamp for the range
587
+ * @param {number} endTs End timestamp for the range
588
+ * @param {GetMarketCandlesticksByEventPeriodIntervalEnum} periodInterval Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day.
589
+ * @param {*} [options] Override http request option.
590
+ * @throws {RequiredError}
591
+ */
592
+ getMarketCandlesticksByEvent(ticker, seriesTicker, startTs, endTs, periodInterval, options) {
593
+ return EventsApiFp(this.configuration).getMarketCandlesticksByEvent(ticker, seriesTicker, startTs, endTs, periodInterval, options).then((request) => request(this.axios, this.basePath));
594
+ }
595
+ /**
596
+ * Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker.
597
+ * @summary Get Multivariate Events
293
598
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
294
- * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
295
- * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
296
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
599
+ * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results.
297
600
  * @param {string} [seriesTicker] Filter by series ticker
298
- * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
601
+ * @param {string} [collectionTicker] Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker.
602
+ * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
299
603
  * @param {*} [options] Override http request option.
300
604
  * @throws {RequiredError}
301
605
  */
302
- getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options) {
303
- return EventsApiFp(this.configuration).getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options).then((request) => request(this.axios, this.basePath));
606
+ getMultivariateEvents(limit, cursor, seriesTicker, collectionTicker, withNestedMarkets, options) {
607
+ return EventsApiFp(this.configuration).getMultivariateEvents(limit, cursor, seriesTicker, collectionTicker, withNestedMarkets, options).then((request) => request(this.axios, this.basePath));
304
608
  }
305
609
  }
610
+ export const GetEventForecastPercentilesHistoryPeriodIntervalEnum = {
611
+ NUMBER_0: 0,
612
+ NUMBER_1: 1,
613
+ NUMBER_60: 60,
614
+ NUMBER_1440: 1440
615
+ };
616
+ export const GetEventsStatusEnum = {
617
+ Open: 'open',
618
+ Closed: 'closed',
619
+ Settled: 'settled'
620
+ };
621
+ export const GetMarketCandlesticksByEventPeriodIntervalEnum = {
622
+ NUMBER_1: 1,
623
+ NUMBER_60: 60,
624
+ NUMBER_1440: 1440
625
+ };