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,9 +1,9 @@
1
1
  /**
2
- * Kalshi Trading API
3
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
2
+ * Kalshi Trade API Manual Endpoints
3
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
4
+ *
5
+ * The version of the OpenAPI document: 3.0.0
4
6
  *
5
- * The version of the OpenAPI document: 2.0.0
6
- * Contact: support@kalshi.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
9
  * https://openapi-generator.tech
@@ -27,7 +27,7 @@ import type { GetRFQsResponse } from '../models';
27
27
  */
28
28
  export declare const CommunicationsApiAxiosParamCreator: (configuration?: Configuration) => {
29
29
  /**
30
- * Accept a quote. This will require the quoter to confirm
30
+ * Endpoint for accepting a quote. This will require the quoter to confirm
31
31
  * @summary Accept Quote
32
32
  * @param {string} quoteId Quote ID
33
33
  * @param {AcceptQuoteRequest} acceptQuoteRequest
@@ -36,15 +36,16 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
36
36
  */
37
37
  acceptQuote: (quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
38
  /**
39
- * Confirm a quote. This will start a timer for order execution
39
+ * Endpoint for confirming a quote. This will start a timer for order execution
40
40
  * @summary Confirm Quote
41
41
  * @param {string} quoteId Quote ID
42
+ * @param {object} [body]
42
43
  * @param {*} [options] Override http request option.
43
44
  * @throws {RequiredError}
44
45
  */
45
- confirmQuote: (quoteId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46
+ confirmQuote: (quoteId: string, body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46
47
  /**
47
- * Create a quote in response to an RFQ
48
+ * Endpoint for creating a quote in response to an RFQ
48
49
  * @summary Create Quote
49
50
  * @param {CreateQuoteRequest} createQuoteRequest
50
51
  * @param {*} [options] Override http request option.
@@ -52,7 +53,7 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
52
53
  */
53
54
  createQuote: (createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
54
55
  /**
55
- * Create a new RFQ
56
+ * Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
56
57
  * @summary Create RFQ
57
58
  * @param {CreateRFQRequest} createRFQRequest
58
59
  * @param {*} [options] Override http request option.
@@ -60,7 +61,7 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
60
61
  */
61
62
  createRFQ: (createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62
63
  /**
63
- * Delete a quote, which means it can no longer be accepted
64
+ * Endpoint for deleting a quote, which means it can no longer be accepted.
64
65
  * @summary Delete Quote
65
66
  * @param {string} quoteId Quote ID
66
67
  * @param {*} [options] Override http request option.
@@ -68,7 +69,7 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
68
69
  */
69
70
  deleteQuote: (quoteId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
70
71
  /**
71
- * Delete an RFQ by ID
72
+ * Endpoint for deleting an RFQ by ID
72
73
  * @summary Delete RFQ
73
74
  * @param {string} rfqId RFQ ID
74
75
  * @param {*} [options] Override http request option.
@@ -76,14 +77,14 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
76
77
  */
77
78
  deleteRFQ: (rfqId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
78
79
  /**
79
- * Get the communications ID of the logged-in user
80
+ * Endpoint for getting the communications ID of the logged-in user.
80
81
  * @summary Get Communications ID
81
82
  * @param {*} [options] Override http request option.
82
83
  * @throws {RequiredError}
83
84
  */
84
85
  getCommunicationsID: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
85
86
  /**
86
- * Get a particular quote by ID
87
+ * Endpoint for getting a particular quote
87
88
  * @summary Get Quote
88
89
  * @param {string} quoteId Quote ID
89
90
  * @param {*} [options] Override http request option.
@@ -91,14 +92,23 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
91
92
  */
92
93
  getQuote: (quoteId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
93
94
  /**
94
- * Retrieve all quotes
95
+ * Endpoint for getting quotes
95
96
  * @summary Get Quotes
97
+ * @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.
98
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
99
+ * @param {string} [marketTicker] Filter by market ticker
100
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 500.
101
+ * @param {string} [status] Filter quotes by status
102
+ * @param {string} [quoteCreatorUserId] Filter quotes by quote creator user ID
103
+ * @param {string} [rfqCreatorUserId] Filter quotes by RFQ creator user ID
104
+ * @param {string} [rfqCreatorSubtraderId] Filter quotes by RFQ creator subtrader ID (FCM members only)
105
+ * @param {string} [rfqId] Filter quotes by RFQ ID
96
106
  * @param {*} [options] Override http request option.
97
107
  * @throws {RequiredError}
98
108
  */
99
- getQuotes: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
109
+ getQuotes: (cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, quoteCreatorUserId?: string, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
100
110
  /**
101
- * Get a single RFQ by ID
111
+ * Endpoint for getting a single RFQ by id
102
112
  * @summary Get RFQ
103
113
  * @param {string} rfqId RFQ ID
104
114
  * @param {*} [options] Override http request option.
@@ -106,19 +116,25 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
106
116
  */
107
117
  getRFQ: (rfqId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
108
118
  /**
109
- * Retrieve all RFQs
119
+ * Endpoint for getting RFQs
110
120
  * @summary Get RFQs
121
+ * @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.
122
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
123
+ * @param {string} [marketTicker] Filter by market ticker
124
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
125
+ * @param {string} [status] Filter RFQs by status
126
+ * @param {string} [creatorUserId] Filter RFQs by creator user ID
111
127
  * @param {*} [options] Override http request option.
112
128
  * @throws {RequiredError}
113
129
  */
114
- getRFQs: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
130
+ getRFQs: (cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, creatorUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
115
131
  };
116
132
  /**
117
133
  * CommunicationsApi - functional programming interface
118
134
  */
119
135
  export declare const CommunicationsApiFp: (configuration?: Configuration) => {
120
136
  /**
121
- * Accept a quote. This will require the quoter to confirm
137
+ * Endpoint for accepting a quote. This will require the quoter to confirm
122
138
  * @summary Accept Quote
123
139
  * @param {string} quoteId Quote ID
124
140
  * @param {AcceptQuoteRequest} acceptQuoteRequest
@@ -127,15 +143,16 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
127
143
  */
128
144
  acceptQuote(quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
129
145
  /**
130
- * Confirm a quote. This will start a timer for order execution
146
+ * Endpoint for confirming a quote. This will start a timer for order execution
131
147
  * @summary Confirm Quote
132
148
  * @param {string} quoteId Quote ID
149
+ * @param {object} [body]
133
150
  * @param {*} [options] Override http request option.
134
151
  * @throws {RequiredError}
135
152
  */
136
- confirmQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
153
+ confirmQuote(quoteId: string, body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
137
154
  /**
138
- * Create a quote in response to an RFQ
155
+ * Endpoint for creating a quote in response to an RFQ
139
156
  * @summary Create Quote
140
157
  * @param {CreateQuoteRequest} createQuoteRequest
141
158
  * @param {*} [options] Override http request option.
@@ -143,7 +160,7 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
143
160
  */
144
161
  createQuote(createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateQuoteResponse>>;
145
162
  /**
146
- * Create a new RFQ
163
+ * Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
147
164
  * @summary Create RFQ
148
165
  * @param {CreateRFQRequest} createRFQRequest
149
166
  * @param {*} [options] Override http request option.
@@ -151,7 +168,7 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
151
168
  */
152
169
  createRFQ(createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRFQResponse>>;
153
170
  /**
154
- * Delete a quote, which means it can no longer be accepted
171
+ * Endpoint for deleting a quote, which means it can no longer be accepted.
155
172
  * @summary Delete Quote
156
173
  * @param {string} quoteId Quote ID
157
174
  * @param {*} [options] Override http request option.
@@ -159,7 +176,7 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
159
176
  */
160
177
  deleteQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
161
178
  /**
162
- * Delete an RFQ by ID
179
+ * Endpoint for deleting an RFQ by ID
163
180
  * @summary Delete RFQ
164
181
  * @param {string} rfqId RFQ ID
165
182
  * @param {*} [options] Override http request option.
@@ -167,14 +184,14 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
167
184
  */
168
185
  deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
169
186
  /**
170
- * Get the communications ID of the logged-in user
187
+ * Endpoint for getting the communications ID of the logged-in user.
171
188
  * @summary Get Communications ID
172
189
  * @param {*} [options] Override http request option.
173
190
  * @throws {RequiredError}
174
191
  */
175
192
  getCommunicationsID(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommunicationsIDResponse>>;
176
193
  /**
177
- * Get a particular quote by ID
194
+ * Endpoint for getting a particular quote
178
195
  * @summary Get Quote
179
196
  * @param {string} quoteId Quote ID
180
197
  * @param {*} [options] Override http request option.
@@ -182,14 +199,23 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
182
199
  */
183
200
  getQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQuoteResponse>>;
184
201
  /**
185
- * Retrieve all quotes
202
+ * Endpoint for getting quotes
186
203
  * @summary Get Quotes
204
+ * @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.
205
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
206
+ * @param {string} [marketTicker] Filter by market ticker
207
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 500.
208
+ * @param {string} [status] Filter quotes by status
209
+ * @param {string} [quoteCreatorUserId] Filter quotes by quote creator user ID
210
+ * @param {string} [rfqCreatorUserId] Filter quotes by RFQ creator user ID
211
+ * @param {string} [rfqCreatorSubtraderId] Filter quotes by RFQ creator subtrader ID (FCM members only)
212
+ * @param {string} [rfqId] Filter quotes by RFQ ID
187
213
  * @param {*} [options] Override http request option.
188
214
  * @throws {RequiredError}
189
215
  */
190
- getQuotes(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQuotesResponse>>;
216
+ getQuotes(cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, quoteCreatorUserId?: string, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQuotesResponse>>;
191
217
  /**
192
- * Get a single RFQ by ID
218
+ * Endpoint for getting a single RFQ by id
193
219
  * @summary Get RFQ
194
220
  * @param {string} rfqId RFQ ID
195
221
  * @param {*} [options] Override http request option.
@@ -197,19 +223,25 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
197
223
  */
198
224
  getRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRFQResponse>>;
199
225
  /**
200
- * Retrieve all RFQs
226
+ * Endpoint for getting RFQs
201
227
  * @summary Get RFQs
228
+ * @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.
229
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
230
+ * @param {string} [marketTicker] Filter by market ticker
231
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
232
+ * @param {string} [status] Filter RFQs by status
233
+ * @param {string} [creatorUserId] Filter RFQs by creator user ID
202
234
  * @param {*} [options] Override http request option.
203
235
  * @throws {RequiredError}
204
236
  */
205
- getRFQs(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRFQsResponse>>;
237
+ getRFQs(cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, creatorUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRFQsResponse>>;
206
238
  };
207
239
  /**
208
240
  * CommunicationsApi - factory interface
209
241
  */
210
242
  export declare const CommunicationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
211
243
  /**
212
- * Accept a quote. This will require the quoter to confirm
244
+ * Endpoint for accepting a quote. This will require the quoter to confirm
213
245
  * @summary Accept Quote
214
246
  * @param {string} quoteId Quote ID
215
247
  * @param {AcceptQuoteRequest} acceptQuoteRequest
@@ -218,15 +250,16 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
218
250
  */
219
251
  acceptQuote(quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
220
252
  /**
221
- * Confirm a quote. This will start a timer for order execution
253
+ * Endpoint for confirming a quote. This will start a timer for order execution
222
254
  * @summary Confirm Quote
223
255
  * @param {string} quoteId Quote ID
256
+ * @param {object} [body]
224
257
  * @param {*} [options] Override http request option.
225
258
  * @throws {RequiredError}
226
259
  */
227
- confirmQuote(quoteId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
260
+ confirmQuote(quoteId: string, body?: object, options?: RawAxiosRequestConfig): AxiosPromise<void>;
228
261
  /**
229
- * Create a quote in response to an RFQ
262
+ * Endpoint for creating a quote in response to an RFQ
230
263
  * @summary Create Quote
231
264
  * @param {CreateQuoteRequest} createQuoteRequest
232
265
  * @param {*} [options] Override http request option.
@@ -234,7 +267,7 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
234
267
  */
235
268
  createQuote(createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateQuoteResponse>;
236
269
  /**
237
- * Create a new RFQ
270
+ * Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
238
271
  * @summary Create RFQ
239
272
  * @param {CreateRFQRequest} createRFQRequest
240
273
  * @param {*} [options] Override http request option.
@@ -242,7 +275,7 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
242
275
  */
243
276
  createRFQ(createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateRFQResponse>;
244
277
  /**
245
- * Delete a quote, which means it can no longer be accepted
278
+ * Endpoint for deleting a quote, which means it can no longer be accepted.
246
279
  * @summary Delete Quote
247
280
  * @param {string} quoteId Quote ID
248
281
  * @param {*} [options] Override http request option.
@@ -250,7 +283,7 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
250
283
  */
251
284
  deleteQuote(quoteId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
252
285
  /**
253
- * Delete an RFQ by ID
286
+ * Endpoint for deleting an RFQ by ID
254
287
  * @summary Delete RFQ
255
288
  * @param {string} rfqId RFQ ID
256
289
  * @param {*} [options] Override http request option.
@@ -258,14 +291,14 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
258
291
  */
259
292
  deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
260
293
  /**
261
- * Get the communications ID of the logged-in user
294
+ * Endpoint for getting the communications ID of the logged-in user.
262
295
  * @summary Get Communications ID
263
296
  * @param {*} [options] Override http request option.
264
297
  * @throws {RequiredError}
265
298
  */
266
299
  getCommunicationsID(options?: RawAxiosRequestConfig): AxiosPromise<GetCommunicationsIDResponse>;
267
300
  /**
268
- * Get a particular quote by ID
301
+ * Endpoint for getting a particular quote
269
302
  * @summary Get Quote
270
303
  * @param {string} quoteId Quote ID
271
304
  * @param {*} [options] Override http request option.
@@ -273,14 +306,23 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
273
306
  */
274
307
  getQuote(quoteId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetQuoteResponse>;
275
308
  /**
276
- * Retrieve all quotes
309
+ * Endpoint for getting quotes
277
310
  * @summary Get Quotes
311
+ * @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.
312
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
313
+ * @param {string} [marketTicker] Filter by market ticker
314
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 500.
315
+ * @param {string} [status] Filter quotes by status
316
+ * @param {string} [quoteCreatorUserId] Filter quotes by quote creator user ID
317
+ * @param {string} [rfqCreatorUserId] Filter quotes by RFQ creator user ID
318
+ * @param {string} [rfqCreatorSubtraderId] Filter quotes by RFQ creator subtrader ID (FCM members only)
319
+ * @param {string} [rfqId] Filter quotes by RFQ ID
278
320
  * @param {*} [options] Override http request option.
279
321
  * @throws {RequiredError}
280
322
  */
281
- getQuotes(options?: RawAxiosRequestConfig): AxiosPromise<GetQuotesResponse>;
323
+ getQuotes(cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, quoteCreatorUserId?: string, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetQuotesResponse>;
282
324
  /**
283
- * Get a single RFQ by ID
325
+ * Endpoint for getting a single RFQ by id
284
326
  * @summary Get RFQ
285
327
  * @param {string} rfqId RFQ ID
286
328
  * @param {*} [options] Override http request option.
@@ -288,19 +330,25 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
288
330
  */
289
331
  getRFQ(rfqId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetRFQResponse>;
290
332
  /**
291
- * Retrieve all RFQs
333
+ * Endpoint for getting RFQs
292
334
  * @summary Get RFQs
335
+ * @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.
336
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
337
+ * @param {string} [marketTicker] Filter by market ticker
338
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
339
+ * @param {string} [status] Filter RFQs by status
340
+ * @param {string} [creatorUserId] Filter RFQs by creator user ID
293
341
  * @param {*} [options] Override http request option.
294
342
  * @throws {RequiredError}
295
343
  */
296
- getRFQs(options?: RawAxiosRequestConfig): AxiosPromise<GetRFQsResponse>;
344
+ getRFQs(cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, creatorUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetRFQsResponse>;
297
345
  };
298
346
  /**
299
347
  * CommunicationsApi - object-oriented interface
300
348
  */
301
349
  export declare class CommunicationsApi extends BaseAPI {
302
350
  /**
303
- * Accept a quote. This will require the quoter to confirm
351
+ * Endpoint for accepting a quote. This will require the quoter to confirm
304
352
  * @summary Accept Quote
305
353
  * @param {string} quoteId Quote ID
306
354
  * @param {AcceptQuoteRequest} acceptQuoteRequest
@@ -309,15 +357,16 @@ export declare class CommunicationsApi extends BaseAPI {
309
357
  */
310
358
  acceptQuote(quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
311
359
  /**
312
- * Confirm a quote. This will start a timer for order execution
360
+ * Endpoint for confirming a quote. This will start a timer for order execution
313
361
  * @summary Confirm Quote
314
362
  * @param {string} quoteId Quote ID
363
+ * @param {object} [body]
315
364
  * @param {*} [options] Override http request option.
316
365
  * @throws {RequiredError}
317
366
  */
318
- confirmQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
367
+ confirmQuote(quoteId: string, body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
319
368
  /**
320
- * Create a quote in response to an RFQ
369
+ * Endpoint for creating a quote in response to an RFQ
321
370
  * @summary Create Quote
322
371
  * @param {CreateQuoteRequest} createQuoteRequest
323
372
  * @param {*} [options] Override http request option.
@@ -325,7 +374,7 @@ export declare class CommunicationsApi extends BaseAPI {
325
374
  */
326
375
  createQuote(createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateQuoteResponse, any, {}>>;
327
376
  /**
328
- * Create a new RFQ
377
+ * Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
329
378
  * @summary Create RFQ
330
379
  * @param {CreateRFQRequest} createRFQRequest
331
380
  * @param {*} [options] Override http request option.
@@ -333,7 +382,7 @@ export declare class CommunicationsApi extends BaseAPI {
333
382
  */
334
383
  createRFQ(createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRFQResponse, any, {}>>;
335
384
  /**
336
- * Delete a quote, which means it can no longer be accepted
385
+ * Endpoint for deleting a quote, which means it can no longer be accepted.
337
386
  * @summary Delete Quote
338
387
  * @param {string} quoteId Quote ID
339
388
  * @param {*} [options] Override http request option.
@@ -341,7 +390,7 @@ export declare class CommunicationsApi extends BaseAPI {
341
390
  */
342
391
  deleteQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
343
392
  /**
344
- * Delete an RFQ by ID
393
+ * Endpoint for deleting an RFQ by ID
345
394
  * @summary Delete RFQ
346
395
  * @param {string} rfqId RFQ ID
347
396
  * @param {*} [options] Override http request option.
@@ -349,14 +398,14 @@ export declare class CommunicationsApi extends BaseAPI {
349
398
  */
350
399
  deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
351
400
  /**
352
- * Get the communications ID of the logged-in user
401
+ * Endpoint for getting the communications ID of the logged-in user.
353
402
  * @summary Get Communications ID
354
403
  * @param {*} [options] Override http request option.
355
404
  * @throws {RequiredError}
356
405
  */
357
406
  getCommunicationsID(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommunicationsIDResponse, any, {}>>;
358
407
  /**
359
- * Get a particular quote by ID
408
+ * Endpoint for getting a particular quote
360
409
  * @summary Get Quote
361
410
  * @param {string} quoteId Quote ID
362
411
  * @param {*} [options] Override http request option.
@@ -364,14 +413,23 @@ export declare class CommunicationsApi extends BaseAPI {
364
413
  */
365
414
  getQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuoteResponse, any, {}>>;
366
415
  /**
367
- * Retrieve all quotes
416
+ * Endpoint for getting quotes
368
417
  * @summary Get Quotes
418
+ * @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.
419
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
420
+ * @param {string} [marketTicker] Filter by market ticker
421
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 500.
422
+ * @param {string} [status] Filter quotes by status
423
+ * @param {string} [quoteCreatorUserId] Filter quotes by quote creator user ID
424
+ * @param {string} [rfqCreatorUserId] Filter quotes by RFQ creator user ID
425
+ * @param {string} [rfqCreatorSubtraderId] Filter quotes by RFQ creator subtrader ID (FCM members only)
426
+ * @param {string} [rfqId] Filter quotes by RFQ ID
369
427
  * @param {*} [options] Override http request option.
370
428
  * @throws {RequiredError}
371
429
  */
372
- getQuotes(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuotesResponse, any, {}>>;
430
+ getQuotes(cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, quoteCreatorUserId?: string, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuotesResponse, any, {}>>;
373
431
  /**
374
- * Get a single RFQ by ID
432
+ * Endpoint for getting a single RFQ by id
375
433
  * @summary Get RFQ
376
434
  * @param {string} rfqId RFQ ID
377
435
  * @param {*} [options] Override http request option.
@@ -379,10 +437,16 @@ export declare class CommunicationsApi extends BaseAPI {
379
437
  */
380
438
  getRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRFQResponse, any, {}>>;
381
439
  /**
382
- * Retrieve all RFQs
440
+ * Endpoint for getting RFQs
383
441
  * @summary Get RFQs
442
+ * @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.
443
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
444
+ * @param {string} [marketTicker] Filter by market ticker
445
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
446
+ * @param {string} [status] Filter RFQs by status
447
+ * @param {string} [creatorUserId] Filter RFQs by creator user ID
384
448
  * @param {*} [options] Override http request option.
385
449
  * @throws {RequiredError}
386
450
  */
387
- getRFQs(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRFQsResponse, any, {}>>;
451
+ getRFQs(cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, creatorUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRFQsResponse, any, {}>>;
388
452
  }