snaptrade-typescript-sdk 3.0.0 → 5.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 (405) hide show
  1. package/.konfig/generate-id.txt +1 -1
  2. package/.konfigignore +3 -1
  3. package/README.md +107 -23
  4. package/api/account-information-api.ts +1075 -0
  5. package/api/api-disclaimer-api.ts +190 -0
  6. package/api/api-status-api.ts +128 -0
  7. package/api/authentication-api.ts +591 -0
  8. package/api/connections-api.ts +425 -0
  9. package/api/error-logs-api.ts +175 -0
  10. package/api/options-api.ts +758 -0
  11. package/api/portfolio-management-api.ts +3402 -0
  12. package/api/reference-data-api.ts +1076 -0
  13. package/api/trading-api.ts +1339 -0
  14. package/api/transactions-and-reporting-api.ts +391 -0
  15. package/api.ts +12 -11530
  16. package/base.ts +1 -2
  17. package/client.ts +55 -0
  18. package/common.ts +16 -54
  19. package/configuration.ts +33 -10
  20. package/dist/api/account-information-api.d.ts +525 -0
  21. package/dist/api/account-information-api.js +1049 -0
  22. package/dist/api/api-disclaimer-api.d.ts +102 -0
  23. package/dist/api/api-disclaimer-api.js +245 -0
  24. package/dist/api/api-status-api.d.ts +70 -0
  25. package/dist/api/api-status-api.js +203 -0
  26. package/dist/api/authentication-api.d.ts +280 -0
  27. package/dist/api/authentication-api.js +659 -0
  28. package/dist/api/connections-api.d.ts +214 -0
  29. package/dist/api/connections-api.js +470 -0
  30. package/dist/api/error-logs-api.d.ts +94 -0
  31. package/dist/api/error-logs-api.js +240 -0
  32. package/dist/api/options-api.d.ts +381 -0
  33. package/dist/api/options-api.js +728 -0
  34. package/dist/api/portfolio-management-api.d.ts +1624 -0
  35. package/dist/api/portfolio-management-api.js +3574 -0
  36. package/dist/api/reference-data-api.d.ts +481 -0
  37. package/dist/api/reference-data-api.js +1244 -0
  38. package/dist/api/trading-api.d.ts +662 -0
  39. package/dist/api/trading-api.js +1276 -0
  40. package/dist/api/transactions-and-reporting-api.d.ts +204 -0
  41. package/dist/api/transactions-and-reporting-api.js +387 -0
  42. package/dist/api.d.ts +12 -7363
  43. package/dist/api.js +24 -9175
  44. package/dist/base.d.ts +1 -1
  45. package/dist/base.js +1 -2
  46. package/dist/client.d.ts +27 -0
  47. package/dist/client.js +34 -0
  48. package/dist/common.d.ts +1 -6
  49. package/dist/common.js +26 -81
  50. package/dist/configuration.d.ts +21 -6
  51. package/dist/configuration.js +13 -8
  52. package/dist/index.d.ts +3 -1
  53. package/dist/index.js +3 -2
  54. package/dist/jest.config.js +0 -1
  55. package/dist/models/account-holdings.d.ts +47 -0
  56. package/dist/models/account-holdings.js +15 -0
  57. package/dist/models/account-order-record-status.d.ts +39 -0
  58. package/dist/models/account-order-record-status.js +43 -0
  59. package/dist/models/account-order-record.d.ts +126 -0
  60. package/dist/models/account-order-record.js +15 -0
  61. package/dist/models/account-simple.d.ts +37 -0
  62. package/dist/models/account-simple.js +15 -0
  63. package/dist/models/account.d.ts +76 -0
  64. package/dist/models/account.js +15 -0
  65. package/dist/models/action.d.ts +21 -0
  66. package/dist/models/action.js +25 -0
  67. package/dist/models/apidisclaimer-accept-request.d.ts +24 -0
  68. package/dist/models/apidisclaimer-accept-request.js +15 -0
  69. package/dist/models/authentication-login-snap-trade-user200-response.d.ts +18 -0
  70. package/dist/models/authentication-login-snap-trade-user200-response.js +15 -0
  71. package/dist/models/balance.d.ts +32 -0
  72. package/dist/models/balance.js +15 -0
  73. package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +37 -0
  74. package/dist/models/brokerage-authorization-type-read-only-brokerage.js +15 -0
  75. package/dist/models/brokerage-authorization-type-read-only.d.ts +56 -0
  76. package/dist/models/brokerage-authorization-type-read-only.js +26 -0
  77. package/dist/models/brokerage-authorization-type.d.ts +30 -0
  78. package/dist/models/brokerage-authorization-type.js +20 -0
  79. package/dist/models/brokerage-authorization.d.ts +76 -0
  80. package/dist/models/brokerage-authorization.js +15 -0
  81. package/dist/models/brokerage-symbol.d.ts +51 -0
  82. package/dist/models/brokerage-symbol.js +15 -0
  83. package/dist/models/brokerage-type.d.ts +31 -0
  84. package/dist/models/brokerage-type.js +15 -0
  85. package/dist/models/brokerage.d.ts +128 -0
  86. package/dist/models/brokerage.js +15 -0
  87. package/dist/models/calculated-trade.d.ts +32 -0
  88. package/dist/models/calculated-trade.js +15 -0
  89. package/dist/models/cash-restriction.d.ts +54 -0
  90. package/dist/models/cash-restriction.js +20 -0
  91. package/dist/models/currency.d.ts +37 -0
  92. package/dist/models/currency.js +15 -0
  93. package/dist/models/delete-user-response.d.ts +31 -0
  94. package/dist/models/delete-user-response.js +15 -0
  95. package/dist/models/dividend-at-date.d.ts +37 -0
  96. package/dist/models/dividend-at-date.js +15 -0
  97. package/dist/models/encrypted-response-encrypted-message-data.d.ts +37 -0
  98. package/dist/models/encrypted-response-encrypted-message-data.js +15 -0
  99. package/dist/models/encrypted-response.d.ts +31 -0
  100. package/dist/models/encrypted-response.js +15 -0
  101. package/dist/models/exchange-rate-pairs.d.ts +38 -0
  102. package/dist/models/exchange-rate-pairs.js +15 -0
  103. package/dist/models/exchange.d.ts +67 -0
  104. package/dist/models/exchange.js +15 -0
  105. package/dist/models/excluded-asset.d.ts +26 -0
  106. package/dist/models/excluded-asset.js +15 -0
  107. package/dist/models/index.d.ts +102 -0
  108. package/dist/models/index.js +118 -0
  109. package/dist/models/jwt.d.ts +25 -0
  110. package/dist/models/jwt.js +15 -0
  111. package/dist/models/login-redirect-uri.d.ts +30 -0
  112. package/dist/models/login-redirect-uri.js +15 -0
  113. package/dist/models/manual-trade-and-impact.d.ts +39 -0
  114. package/dist/models/manual-trade-and-impact.js +15 -0
  115. package/dist/models/manual-trade-balance.d.ts +39 -0
  116. package/dist/models/manual-trade-balance.js +15 -0
  117. package/dist/models/manual-trade-form.d.ts +69 -0
  118. package/dist/models/manual-trade-form.js +15 -0
  119. package/dist/models/manual-trade-symbol.d.ts +56 -0
  120. package/dist/models/manual-trade-symbol.js +15 -0
  121. package/dist/models/manual-trade.d.ts +72 -0
  122. package/dist/models/manual-trade.js +15 -0
  123. package/dist/models/model-asset-class-details.d.ts +32 -0
  124. package/dist/models/model-asset-class-details.js +15 -0
  125. package/dist/models/model-asset-class-target.d.ts +26 -0
  126. package/dist/models/model-asset-class-target.js +15 -0
  127. package/dist/models/model-asset-class.d.ts +31 -0
  128. package/dist/models/model-asset-class.js +15 -0
  129. package/dist/models/model-portfolio-asset-class.d.ts +32 -0
  130. package/dist/models/model-portfolio-asset-class.js +15 -0
  131. package/dist/models/model-portfolio-details.d.ts +39 -0
  132. package/dist/models/model-portfolio-details.js +15 -0
  133. package/dist/models/model-portfolio-security.d.ts +32 -0
  134. package/dist/models/model-portfolio-security.js +15 -0
  135. package/dist/models/model-portfolio.d.ts +43 -0
  136. package/dist/models/model-portfolio.js +21 -0
  137. package/dist/models/model400-failed-request-response.d.ts +31 -0
  138. package/dist/models/model400-failed-request-response.js +15 -0
  139. package/dist/models/model401-failed-request-response.d.ts +31 -0
  140. package/dist/models/model401-failed-request-response.js +15 -0
  141. package/dist/models/model403-failed-request-response.d.ts +31 -0
  142. package/dist/models/model403-failed-request-response.js +15 -0
  143. package/dist/models/model404-failed-request-response.d.ts +31 -0
  144. package/dist/models/model404-failed-request-response.js +15 -0
  145. package/dist/models/monthly-dividends.d.ts +32 -0
  146. package/dist/models/monthly-dividends.js +15 -0
  147. package/dist/models/net-contributions.d.ts +37 -0
  148. package/dist/models/net-contributions.js +15 -0
  149. package/dist/models/net-dividend.d.ts +38 -0
  150. package/dist/models/net-dividend.js +15 -0
  151. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +37 -0
  152. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +15 -0
  153. package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +38 -0
  154. package/dist/models/option-chain-inner-chain-per-root-inner.js +15 -0
  155. package/dist/models/option-chain-inner.d.ts +50 -0
  156. package/dist/models/option-chain-inner.js +15 -0
  157. package/dist/models/option-leg.d.ts +44 -0
  158. package/dist/models/option-leg.js +22 -0
  159. package/dist/models/option-strategy-legs-inner.d.ts +42 -0
  160. package/dist/models/option-strategy-legs-inner.js +15 -0
  161. package/dist/models/option-strategy.d.ts +51 -0
  162. package/dist/models/option-strategy.js +15 -0
  163. package/dist/models/options-get-option-strategy-request.d.ts +41 -0
  164. package/dist/models/options-get-option-strategy-request.js +19 -0
  165. package/dist/models/options-holdings.d.ts +57 -0
  166. package/dist/models/options-holdings.js +15 -0
  167. package/dist/models/options-place-option-strategy-request.d.ts +48 -0
  168. package/dist/models/options-place-option-strategy-request.js +26 -0
  169. package/dist/models/options-position.d.ts +63 -0
  170. package/dist/models/options-position.js +15 -0
  171. package/dist/models/options-symbol.d.ts +86 -0
  172. package/dist/models/options-symbol.js +15 -0
  173. package/dist/models/order-type.d.ts +23 -0
  174. package/dist/models/order-type.js +27 -0
  175. package/dist/models/partner-data.d.ts +92 -0
  176. package/dist/models/partner-data.js +15 -0
  177. package/dist/models/past-value.d.ts +37 -0
  178. package/dist/models/past-value.js +15 -0
  179. package/dist/models/performance-custom.d.ts +138 -0
  180. package/dist/models/performance-custom.js +15 -0
  181. package/dist/models/portfolio-group-info.d.ts +93 -0
  182. package/dist/models/portfolio-group-info.js +15 -0
  183. package/dist/models/portfolio-group-position.d.ts +38 -0
  184. package/dist/models/portfolio-group-position.js +15 -0
  185. package/dist/models/portfolio-group-settings.d.ts +50 -0
  186. package/dist/models/portfolio-group-settings.js +15 -0
  187. package/dist/models/portfolio-group.d.ts +31 -0
  188. package/dist/models/portfolio-group.js +15 -0
  189. package/dist/models/position-symbol.d.ts +56 -0
  190. package/dist/models/position-symbol.js +15 -0
  191. package/dist/models/position.d.ts +56 -0
  192. package/dist/models/position.js +15 -0
  193. package/dist/models/redirect-tokenand-pin.d.ts +31 -0
  194. package/dist/models/redirect-tokenand-pin.js +15 -0
  195. package/dist/models/security-type.d.ts +43 -0
  196. package/dist/models/security-type.js +15 -0
  197. package/dist/models/snap-trade-apidisclaimer-accept-status.d.ts +31 -0
  198. package/dist/models/snap-trade-apidisclaimer-accept-status.js +15 -0
  199. package/dist/models/snap-trade-holdings-account.d.ts +64 -0
  200. package/dist/models/snap-trade-holdings-account.js +15 -0
  201. package/dist/models/snap-trade-holdings-total-value.d.ts +31 -0
  202. package/dist/models/snap-trade-holdings-total-value.js +15 -0
  203. package/dist/models/snap-trade-login-user-request-body.d.ts +53 -0
  204. package/dist/models/snap-trade-login-user-request-body.js +20 -0
  205. package/dist/models/snap-trade-register-user-request-body.d.ts +30 -0
  206. package/dist/models/snap-trade-register-user-request-body.js +15 -0
  207. package/dist/models/status.d.ts +37 -0
  208. package/dist/models/status.js +15 -0
  209. package/dist/models/strategy-impact-legs-inner.d.ts +61 -0
  210. package/dist/models/strategy-impact-legs-inner.js +15 -0
  211. package/dist/models/strategy-impact.d.ts +86 -0
  212. package/dist/models/strategy-impact.js +15 -0
  213. package/dist/models/strategy-order-place-orders-inner-legs-inner.d.ts +61 -0
  214. package/dist/models/strategy-order-place-orders-inner-legs-inner.js +15 -0
  215. package/dist/models/strategy-order-place-orders-inner.d.ts +278 -0
  216. package/dist/models/strategy-order-place-orders-inner.js +15 -0
  217. package/dist/models/strategy-order-place.d.ts +32 -0
  218. package/dist/models/strategy-order-place.js +15 -0
  219. package/dist/models/strategy-order-record.d.ts +120 -0
  220. package/dist/models/strategy-order-record.js +47 -0
  221. package/dist/models/strategy-quotes-greek.d.ts +49 -0
  222. package/dist/models/strategy-quotes-greek.js +15 -0
  223. package/dist/models/strategy-quotes.d.ts +57 -0
  224. package/dist/models/strategy-quotes.js +15 -0
  225. package/dist/models/sub-period-return-rate.d.ts +37 -0
  226. package/dist/models/sub-period-return-rate.js +15 -0
  227. package/dist/models/symbol-query.d.ts +24 -0
  228. package/dist/models/symbol-query.js +15 -0
  229. package/dist/models/symbol.d.ts +51 -0
  230. package/dist/models/symbol.js +15 -0
  231. package/dist/models/symbols-quotes.d.ts +56 -0
  232. package/dist/models/symbols-quotes.js +15 -0
  233. package/dist/models/target-asset.d.ts +55 -0
  234. package/dist/models/target-asset.js +15 -0
  235. package/dist/models/time-in-force.d.ts +22 -0
  236. package/dist/models/time-in-force.js +26 -0
  237. package/dist/models/trade-execution-status.d.ts +91 -0
  238. package/dist/models/trade-execution-status.js +27 -0
  239. package/dist/models/trade-impact.d.ts +51 -0
  240. package/dist/models/trade-impact.js +15 -0
  241. package/dist/models/trade.d.ts +74 -0
  242. package/dist/models/trade.js +20 -0
  243. package/dist/models/trading-place-ocoorder-request.d.ts +30 -0
  244. package/dist/models/trading-place-ocoorder-request.js +15 -0
  245. package/dist/models/underlying-symbol.d.ts +64 -0
  246. package/dist/models/underlying-symbol.js +15 -0
  247. package/dist/models/universal-activity.d.ts +134 -0
  248. package/dist/models/universal-activity.js +36 -0
  249. package/dist/models/universal-symbol-ticker.d.ts +70 -0
  250. package/dist/models/universal-symbol-ticker.js +15 -0
  251. package/dist/models/universal-symbol.d.ts +69 -0
  252. package/dist/models/universal-symbol.js +15 -0
  253. package/dist/models/user-error-log.d.ts +55 -0
  254. package/dist/models/user-error-log.js +15 -0
  255. package/dist/models/user-idand-secret.d.ts +31 -0
  256. package/dist/models/user-idand-secret.js +15 -0
  257. package/dist/models/user-settings.d.ts +80 -0
  258. package/dist/models/user-settings.js +15 -0
  259. package/dist/models/usexchange.d.ts +73 -0
  260. package/dist/models/usexchange.js +15 -0
  261. package/dist/pagination/page-types.d.ts +27 -0
  262. package/dist/pagination/page-types.js +13 -0
  263. package/dist/pagination/page.d.ts +36 -0
  264. package/dist/pagination/page.js +61 -0
  265. package/dist/pagination/pageable.d.ts +58 -0
  266. package/dist/pagination/pageable.js +127 -0
  267. package/dist/pagination/paginate.d.ts +17 -0
  268. package/dist/pagination/paginate.js +78 -0
  269. package/dist/requestAfterHook.d.ts +8 -0
  270. package/dist/requestAfterHook.js +45 -0
  271. package/dist/requestBeforeHook.d.ts +8 -0
  272. package/dist/requestBeforeHook.js +8 -0
  273. package/docs/AccountInformationApi.md +485 -0
  274. package/docs/ApiDisclaimerApi.md +69 -0
  275. package/docs/ApiStatusApi.md +60 -0
  276. package/docs/AuthenticationApi.md +307 -0
  277. package/docs/ConnectionsApi.md +186 -0
  278. package/docs/ErrorLogsApi.md +65 -0
  279. package/docs/OptionsApi.md +321 -0
  280. package/docs/PortfolioManagementApi.md +1866 -0
  281. package/docs/ReferenceDataApi.md +597 -0
  282. package/docs/TradingApi.md +629 -0
  283. package/docs/TransactionsAndReportingApi.md +141 -0
  284. package/index.test.ts +62 -13
  285. package/index.ts +3 -3
  286. package/models/account-holdings.ts +61 -0
  287. package/models/account-order-record-status.ts +48 -0
  288. package/models/account-order-record.ts +142 -0
  289. package/models/account-simple.ts +43 -0
  290. package/models/account.ts +82 -0
  291. package/models/action.ts +30 -0
  292. package/models/apidisclaimer-accept-request.ts +29 -0
  293. package/models/authentication-login-snap-trade-user200-response.ts +31 -0
  294. package/models/balance.ts +40 -0
  295. package/models/brokerage-authorization-type-read-only-brokerage.ts +43 -0
  296. package/models/brokerage-authorization-type-read-only.ts +68 -0
  297. package/models/brokerage-authorization-type.ts +39 -0
  298. package/models/brokerage-authorization.ts +82 -0
  299. package/models/brokerage-symbol.ts +61 -0
  300. package/models/brokerage-type.ts +37 -0
  301. package/models/brokerage.ts +136 -0
  302. package/models/calculated-trade.ts +40 -0
  303. package/models/cash-restriction.ts +63 -0
  304. package/models/currency.ts +43 -0
  305. package/models/delete-user-response.ts +37 -0
  306. package/models/dividend-at-date.ts +43 -0
  307. package/models/encrypted-response-encrypted-message-data.ts +43 -0
  308. package/models/encrypted-response.ts +38 -0
  309. package/models/exchange-rate-pairs.ts +46 -0
  310. package/models/exchange.ts +73 -0
  311. package/models/excluded-asset.ts +34 -0
  312. package/models/index.ts +102 -0
  313. package/models/jwt.ts +31 -0
  314. package/models/login-redirect-uri.ts +35 -0
  315. package/models/manual-trade-and-impact.ts +49 -0
  316. package/models/manual-trade-balance.ts +49 -0
  317. package/models/manual-trade-form.ts +80 -0
  318. package/models/manual-trade-symbol.ts +64 -0
  319. package/models/manual-trade.ts +88 -0
  320. package/models/model-asset-class-details.ts +41 -0
  321. package/models/model-asset-class-target.ts +34 -0
  322. package/models/model-asset-class.ts +37 -0
  323. package/models/model-portfolio-asset-class.ts +40 -0
  324. package/models/model-portfolio-details.ts +50 -0
  325. package/models/model-portfolio-security.ts +40 -0
  326. package/models/model-portfolio.ts +52 -0
  327. package/models/model400-failed-request-response.ts +37 -0
  328. package/models/model401-failed-request-response.ts +37 -0
  329. package/models/model403-failed-request-response.ts +37 -0
  330. package/models/model404-failed-request-response.ts +37 -0
  331. package/models/monthly-dividends.ts +40 -0
  332. package/models/net-contributions.ts +43 -0
  333. package/models/net-dividend.ts +46 -0
  334. package/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.ts +43 -0
  335. package/models/option-chain-inner-chain-per-root-inner.ts +46 -0
  336. package/models/option-chain-inner.ts +58 -0
  337. package/models/option-leg.ts +53 -0
  338. package/models/option-strategy-legs-inner.ts +47 -0
  339. package/models/option-strategy.ts +61 -0
  340. package/models/options-get-option-strategy-request.ts +51 -0
  341. package/models/options-holdings.ts +67 -0
  342. package/models/options-place-option-strategy-request.ts +57 -0
  343. package/models/options-position.ts +73 -0
  344. package/models/options-symbol.ts +94 -0
  345. package/models/order-type.ts +32 -0
  346. package/models/partner-data.ts +100 -0
  347. package/models/past-value.ts +43 -0
  348. package/models/performance-custom.ts +154 -0
  349. package/models/portfolio-group-info.ts +115 -0
  350. package/models/portfolio-group-position.ts +46 -0
  351. package/models/portfolio-group-settings.ts +58 -0
  352. package/models/portfolio-group.ts +37 -0
  353. package/models/position-symbol.ts +64 -0
  354. package/models/position.ts +64 -0
  355. package/models/redirect-tokenand-pin.ts +37 -0
  356. package/models/security-type.ts +49 -0
  357. package/models/snap-trade-apidisclaimer-accept-status.ts +37 -0
  358. package/models/snap-trade-holdings-account.ts +70 -0
  359. package/models/snap-trade-holdings-total-value.ts +37 -0
  360. package/models/snap-trade-login-user-request-body.ts +61 -0
  361. package/models/snap-trade-register-user-request-body.ts +35 -0
  362. package/models/status.ts +43 -0
  363. package/models/strategy-impact-legs-inner.ts +67 -0
  364. package/models/strategy-impact.ts +94 -0
  365. package/models/strategy-order-place-orders-inner-legs-inner.ts +67 -0
  366. package/models/strategy-order-place-orders-inner.ts +286 -0
  367. package/models/strategy-order-place.ts +40 -0
  368. package/models/strategy-order-record.ts +133 -0
  369. package/models/strategy-quotes-greek.ts +55 -0
  370. package/models/strategy-quotes.ts +67 -0
  371. package/models/sub-period-return-rate.ts +43 -0
  372. package/models/symbol-query.ts +29 -0
  373. package/models/symbol.ts +61 -0
  374. package/models/symbols-quotes.ts +64 -0
  375. package/models/target-asset.ts +62 -0
  376. package/models/time-in-force.ts +31 -0
  377. package/models/trade-execution-status.ts +105 -0
  378. package/models/trade-impact.ts +61 -0
  379. package/models/trade.ts +88 -0
  380. package/models/trading-place-ocoorder-request.ts +35 -0
  381. package/models/underlying-symbol.ts +76 -0
  382. package/models/universal-activity.ts +151 -0
  383. package/models/universal-symbol-ticker.ts +82 -0
  384. package/models/universal-symbol.ts +80 -0
  385. package/models/user-error-log.ts +61 -0
  386. package/models/user-idand-secret.ts +37 -0
  387. package/models/user-settings.ts +88 -0
  388. package/models/usexchange.ts +79 -0
  389. package/package.json +1 -1
  390. package/pagination/page-types.ts +34 -0
  391. package/pagination/page.ts +58 -0
  392. package/pagination/pageable.ts +113 -0
  393. package/pagination/paginate.ts +41 -0
  394. package/requestAfterHook.ts +53 -0
  395. package/requestBeforeHook.ts +14 -0
  396. package/tsconfig.json +1 -1
  397. package/dist/api.js.map +0 -1
  398. package/dist/base.js.map +0 -1
  399. package/dist/common.js.map +0 -1
  400. package/dist/configuration.js.map +0 -1
  401. package/dist/index.js.map +0 -1
  402. package/dist/index.test.d.ts +0 -1
  403. package/dist/index.test.js +0 -105
  404. package/dist/index.test.js.map +0 -1
  405. package/dist/jest.config.js.map +0 -1
@@ -0,0 +1,758 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * SnapTrade
5
+ * Connect brokerage accounts to your app for live positions and trading
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: api@snaptrade.com
9
+ *
10
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
11
+ * https://konfigthis.com
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
16
+ import { Configuration } from '../configuration';
17
+ // Some imports not used depending on template conditions
18
+ // @ts-ignore
19
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
20
+ // @ts-ignore
21
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
22
+ // @ts-ignore
23
+ import { OptionChainInner } from '../models';
24
+ // @ts-ignore
25
+ import { OptionsGetOptionStrategyRequest } from '../models';
26
+ // @ts-ignore
27
+ import { OptionsHoldings } from '../models';
28
+ // @ts-ignore
29
+ import { OptionsPlaceOptionStrategyRequest } from '../models';
30
+ // @ts-ignore
31
+ import { StrategyOrderRecord } from '../models';
32
+ // @ts-ignore
33
+ import { StrategyQuotes } from '../models';
34
+ import { paginate } from "../pagination/paginate";
35
+ import { requestBeforeHook } from '../requestBeforeHook';
36
+ /**
37
+ * OptionsApi - axios parameter creator
38
+ * @export
39
+ */
40
+ export const OptionsApiAxiosParamCreator = function (configuration?: Configuration) {
41
+ return {
42
+ /**
43
+ *
44
+ * @summary Creates an option strategy object that will be used to place an option strategy order
45
+ * @param {string} userId
46
+ * @param {string} userSecret
47
+ * @param {string} accountId The ID of the account get positions.
48
+ * @param {OptionsGetOptionStrategyRequest} optionsGetOptionStrategyRequest
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ getOptionStrategy: async (userId: string, userSecret: string, accountId: string, optionsGetOptionStrategyRequest: OptionsGetOptionStrategyRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
53
+ // verify required parameter 'userId' is not null or undefined
54
+ assertParamExists('getOptionStrategy', 'userId', userId)
55
+ // verify required parameter 'userSecret' is not null or undefined
56
+ assertParamExists('getOptionStrategy', 'userSecret', userSecret)
57
+ // verify required parameter 'accountId' is not null or undefined
58
+ assertParamExists('getOptionStrategy', 'accountId', accountId)
59
+ // verify required parameter 'optionsGetOptionStrategyRequest' is not null or undefined
60
+ assertParamExists('getOptionStrategy', 'optionsGetOptionStrategyRequest', optionsGetOptionStrategyRequest)
61
+ const localVarPath = `/accounts/{accountId}/optionStrategy`
62
+ .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)));
63
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
64
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
65
+ let baseOptions;
66
+ if (configuration) {
67
+ baseOptions = configuration.baseOptions;
68
+ }
69
+
70
+ const localVarRequestOptions: AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
71
+ const localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {} as any;
72
+ const localVarQueryParameter = {} as any;
73
+
74
+ // authentication PartnerClientId required
75
+ await setApiKeyToObject(localVarQueryParameter, "clientId", configuration)
76
+
77
+ // authentication PartnerSignature required
78
+ await setApiKeyToObject(localVarHeaderParameter, "Signature", configuration)
79
+
80
+ // authentication PartnerTimestamp required
81
+ await setApiKeyToObject(localVarQueryParameter, "timestamp", configuration)
82
+
83
+ if (userId !== undefined) {
84
+ localVarQueryParameter['userId'] = userId;
85
+ }
86
+
87
+ if (userSecret !== undefined) {
88
+ localVarQueryParameter['userSecret'] = userSecret;
89
+ }
90
+
91
+
92
+
93
+ localVarHeaderParameter['Content-Type'] = 'application/json';
94
+
95
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
96
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
97
+ localVarRequestOptions.data = serializeDataIfNeeded(optionsGetOptionStrategyRequest, localVarRequestOptions, configuration)
98
+
99
+ requestBeforeHook({
100
+ queryParameters: localVarQueryParameter,
101
+ requestConfig: localVarRequestOptions,
102
+ path: localVarPath,
103
+ configuration
104
+ });
105
+
106
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
107
+ return {
108
+ url: toPathString(localVarUrlObj),
109
+ options: localVarRequestOptions,
110
+ };
111
+ },
112
+ /**
113
+ *
114
+ * @summary Get the options chain
115
+ * @param {string} userId
116
+ * @param {string} userSecret
117
+ * @param {string} accountId The ID of the account get positions.
118
+ * @param {string} symbol Universal symbol ID if symbol
119
+ * @param {*} [options] Override http request option.
120
+ * @throws {RequiredError}
121
+ */
122
+ getOptionsChain: async (userId: string, userSecret: string, accountId: string, symbol: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
123
+ // verify required parameter 'userId' is not null or undefined
124
+ assertParamExists('getOptionsChain', 'userId', userId)
125
+ // verify required parameter 'userSecret' is not null or undefined
126
+ assertParamExists('getOptionsChain', 'userSecret', userSecret)
127
+ // verify required parameter 'accountId' is not null or undefined
128
+ assertParamExists('getOptionsChain', 'accountId', accountId)
129
+ // verify required parameter 'symbol' is not null or undefined
130
+ assertParamExists('getOptionsChain', 'symbol', symbol)
131
+ const localVarPath = `/accounts/{accountId}/optionsChain`
132
+ .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)));
133
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
134
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
135
+ let baseOptions;
136
+ if (configuration) {
137
+ baseOptions = configuration.baseOptions;
138
+ }
139
+
140
+ const localVarRequestOptions: AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
141
+ const localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {} as any;
142
+ const localVarQueryParameter = {} as any;
143
+
144
+ // authentication PartnerClientId required
145
+ await setApiKeyToObject(localVarQueryParameter, "clientId", configuration)
146
+
147
+ // authentication PartnerSignature required
148
+ await setApiKeyToObject(localVarHeaderParameter, "Signature", configuration)
149
+
150
+ // authentication PartnerTimestamp required
151
+ await setApiKeyToObject(localVarQueryParameter, "timestamp", configuration)
152
+
153
+ if (userId !== undefined) {
154
+ localVarQueryParameter['userId'] = userId;
155
+ }
156
+
157
+ if (userSecret !== undefined) {
158
+ localVarQueryParameter['userSecret'] = userSecret;
159
+ }
160
+
161
+ if (symbol !== undefined) {
162
+ localVarQueryParameter['symbol'] = symbol;
163
+ }
164
+
165
+
166
+
167
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
168
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
169
+
170
+ requestBeforeHook({
171
+ queryParameters: localVarQueryParameter,
172
+ requestConfig: localVarRequestOptions,
173
+ path: localVarPath,
174
+ configuration
175
+ });
176
+
177
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
178
+ return {
179
+ url: toPathString(localVarUrlObj),
180
+ options: localVarRequestOptions,
181
+ };
182
+ },
183
+ /**
184
+ *
185
+ * @summary Get latest market data of option strategy
186
+ * @param {string} userId
187
+ * @param {string} userSecret
188
+ * @param {string} accountId The ID of the account get positions.
189
+ * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
190
+ * @param {*} [options] Override http request option.
191
+ * @throws {RequiredError}
192
+ */
193
+ getOptionsStrategyQuote: async (userId: string, userSecret: string, accountId: string, optionStrategyId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
194
+ // verify required parameter 'userId' is not null or undefined
195
+ assertParamExists('getOptionsStrategyQuote', 'userId', userId)
196
+ // verify required parameter 'userSecret' is not null or undefined
197
+ assertParamExists('getOptionsStrategyQuote', 'userSecret', userSecret)
198
+ // verify required parameter 'accountId' is not null or undefined
199
+ assertParamExists('getOptionsStrategyQuote', 'accountId', accountId)
200
+ // verify required parameter 'optionStrategyId' is not null or undefined
201
+ assertParamExists('getOptionsStrategyQuote', 'optionStrategyId', optionStrategyId)
202
+ const localVarPath = `/accounts/{accountId}/optionStrategy/{optionStrategyId}`
203
+ .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
204
+ .replace(`{${"optionStrategyId"}}`, encodeURIComponent(String(optionStrategyId)));
205
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
206
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
207
+ let baseOptions;
208
+ if (configuration) {
209
+ baseOptions = configuration.baseOptions;
210
+ }
211
+
212
+ const localVarRequestOptions: AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
213
+ const localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {} as any;
214
+ const localVarQueryParameter = {} as any;
215
+
216
+ // authentication PartnerClientId required
217
+ await setApiKeyToObject(localVarQueryParameter, "clientId", configuration)
218
+
219
+ // authentication PartnerSignature required
220
+ await setApiKeyToObject(localVarHeaderParameter, "Signature", configuration)
221
+
222
+ // authentication PartnerTimestamp required
223
+ await setApiKeyToObject(localVarQueryParameter, "timestamp", configuration)
224
+
225
+ if (userId !== undefined) {
226
+ localVarQueryParameter['userId'] = userId;
227
+ }
228
+
229
+ if (userSecret !== undefined) {
230
+ localVarQueryParameter['userSecret'] = userSecret;
231
+ }
232
+
233
+
234
+
235
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
236
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
237
+
238
+ requestBeforeHook({
239
+ queryParameters: localVarQueryParameter,
240
+ requestConfig: localVarRequestOptions,
241
+ path: localVarPath,
242
+ configuration
243
+ });
244
+
245
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
246
+ return {
247
+ url: toPathString(localVarUrlObj),
248
+ options: localVarRequestOptions,
249
+ };
250
+ },
251
+ /**
252
+ *
253
+ * @summary Get the options holdings in the account
254
+ * @param {string} userId
255
+ * @param {string} userSecret
256
+ * @param {string} accountId The ID of the account get positions.
257
+ * @param {*} [options] Override http request option.
258
+ * @throws {RequiredError}
259
+ */
260
+ listOptionHoldings: async (userId: string, userSecret: string, accountId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
261
+ // verify required parameter 'userId' is not null or undefined
262
+ assertParamExists('listOptionHoldings', 'userId', userId)
263
+ // verify required parameter 'userSecret' is not null or undefined
264
+ assertParamExists('listOptionHoldings', 'userSecret', userSecret)
265
+ // verify required parameter 'accountId' is not null or undefined
266
+ assertParamExists('listOptionHoldings', 'accountId', accountId)
267
+ const localVarPath = `/accounts/{accountId}/options`
268
+ .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)));
269
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
270
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
271
+ let baseOptions;
272
+ if (configuration) {
273
+ baseOptions = configuration.baseOptions;
274
+ }
275
+
276
+ const localVarRequestOptions: AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
277
+ const localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {} as any;
278
+ const localVarQueryParameter = {} as any;
279
+
280
+ // authentication PartnerClientId required
281
+ await setApiKeyToObject(localVarQueryParameter, "clientId", configuration)
282
+
283
+ // authentication PartnerSignature required
284
+ await setApiKeyToObject(localVarHeaderParameter, "Signature", configuration)
285
+
286
+ // authentication PartnerTimestamp required
287
+ await setApiKeyToObject(localVarQueryParameter, "timestamp", configuration)
288
+
289
+ if (userId !== undefined) {
290
+ localVarQueryParameter['userId'] = userId;
291
+ }
292
+
293
+ if (userSecret !== undefined) {
294
+ localVarQueryParameter['userSecret'] = userSecret;
295
+ }
296
+
297
+
298
+
299
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
300
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
301
+
302
+ requestBeforeHook({
303
+ queryParameters: localVarQueryParameter,
304
+ requestConfig: localVarRequestOptions,
305
+ path: localVarPath,
306
+ configuration
307
+ });
308
+
309
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
310
+ return {
311
+ url: toPathString(localVarUrlObj),
312
+ options: localVarRequestOptions,
313
+ };
314
+ },
315
+ /**
316
+ *
317
+ * @summary Place an option strategy order on the brokerage
318
+ * @param {string} userId
319
+ * @param {string} userSecret
320
+ * @param {string} accountId The ID of the account get positions.
321
+ * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
322
+ * @param {OptionsPlaceOptionStrategyRequest} optionsPlaceOptionStrategyRequest
323
+ * @param {*} [options] Override http request option.
324
+ * @throws {RequiredError}
325
+ */
326
+ placeOptionStrategy: async (userId: string, userSecret: string, accountId: string, optionStrategyId: string, optionsPlaceOptionStrategyRequest: OptionsPlaceOptionStrategyRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
327
+ // verify required parameter 'userId' is not null or undefined
328
+ assertParamExists('placeOptionStrategy', 'userId', userId)
329
+ // verify required parameter 'userSecret' is not null or undefined
330
+ assertParamExists('placeOptionStrategy', 'userSecret', userSecret)
331
+ // verify required parameter 'accountId' is not null or undefined
332
+ assertParamExists('placeOptionStrategy', 'accountId', accountId)
333
+ // verify required parameter 'optionStrategyId' is not null or undefined
334
+ assertParamExists('placeOptionStrategy', 'optionStrategyId', optionStrategyId)
335
+ // verify required parameter 'optionsPlaceOptionStrategyRequest' is not null or undefined
336
+ assertParamExists('placeOptionStrategy', 'optionsPlaceOptionStrategyRequest', optionsPlaceOptionStrategyRequest)
337
+ const localVarPath = `/accounts/{accountId}/optionStrategy/{optionStrategyId}/execute`
338
+ .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
339
+ .replace(`{${"optionStrategyId"}}`, encodeURIComponent(String(optionStrategyId)));
340
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
341
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
342
+ let baseOptions;
343
+ if (configuration) {
344
+ baseOptions = configuration.baseOptions;
345
+ }
346
+
347
+ const localVarRequestOptions: AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
348
+ const localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {} as any;
349
+ const localVarQueryParameter = {} as any;
350
+
351
+ // authentication PartnerClientId required
352
+ await setApiKeyToObject(localVarQueryParameter, "clientId", configuration)
353
+
354
+ // authentication PartnerSignature required
355
+ await setApiKeyToObject(localVarHeaderParameter, "Signature", configuration)
356
+
357
+ // authentication PartnerTimestamp required
358
+ await setApiKeyToObject(localVarQueryParameter, "timestamp", configuration)
359
+
360
+ if (userId !== undefined) {
361
+ localVarQueryParameter['userId'] = userId;
362
+ }
363
+
364
+ if (userSecret !== undefined) {
365
+ localVarQueryParameter['userSecret'] = userSecret;
366
+ }
367
+
368
+
369
+
370
+ localVarHeaderParameter['Content-Type'] = 'application/json';
371
+
372
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
373
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
374
+ localVarRequestOptions.data = serializeDataIfNeeded(optionsPlaceOptionStrategyRequest, localVarRequestOptions, configuration)
375
+
376
+ requestBeforeHook({
377
+ queryParameters: localVarQueryParameter,
378
+ requestConfig: localVarRequestOptions,
379
+ path: localVarPath,
380
+ configuration
381
+ });
382
+
383
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
384
+ return {
385
+ url: toPathString(localVarUrlObj),
386
+ options: localVarRequestOptions,
387
+ };
388
+ },
389
+ }
390
+ };
391
+
392
+ /**
393
+ * OptionsApi - functional programming interface
394
+ * @export
395
+ */
396
+ export const OptionsApiFp = function(configuration?: Configuration) {
397
+ const localVarAxiosParamCreator = OptionsApiAxiosParamCreator(configuration)
398
+ return {
399
+ /**
400
+ *
401
+ * @summary Creates an option strategy object that will be used to place an option strategy order
402
+ * @param {OptionsApiGetOptionStrategyRequest} requestParameters Request parameters.
403
+ * @param {*} [options] Override http request option.
404
+ * @throws {RequiredError}
405
+ */
406
+ async getOptionStrategy(requestParameters: OptionsApiGetOptionStrategyRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StrategyQuotes>> {
407
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionStrategy(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.requestBody, options);
408
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
409
+ },
410
+ /**
411
+ *
412
+ * @summary Get the options chain
413
+ * @param {OptionsApiGetOptionsChainRequest} requestParameters Request parameters.
414
+ * @param {*} [options] Override http request option.
415
+ * @throws {RequiredError}
416
+ */
417
+ async getOptionsChain(requestParameters: OptionsApiGetOptionsChainRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChainInner>>> {
418
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionsChain(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.symbol, options);
419
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
420
+ },
421
+ /**
422
+ *
423
+ * @summary Get latest market data of option strategy
424
+ * @param {OptionsApiGetOptionsStrategyQuoteRequest} requestParameters Request parameters.
425
+ * @param {*} [options] Override http request option.
426
+ * @throws {RequiredError}
427
+ */
428
+ async getOptionsStrategyQuote(requestParameters: OptionsApiGetOptionsStrategyQuoteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StrategyQuotes>> {
429
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionsStrategyQuote(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.optionStrategyId, options);
430
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
431
+ },
432
+ /**
433
+ *
434
+ * @summary Get the options holdings in the account
435
+ * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
436
+ * @param {*} [options] Override http request option.
437
+ * @throws {RequiredError}
438
+ */
439
+ async listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionsHoldings>> {
440
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listOptionHoldings(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, options);
441
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
442
+ },
443
+ /**
444
+ *
445
+ * @summary Place an option strategy order on the brokerage
446
+ * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
447
+ * @param {*} [options] Override http request option.
448
+ * @throws {RequiredError}
449
+ */
450
+ async placeOptionStrategy(requestParameters: OptionsApiPlaceOptionStrategyRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StrategyOrderRecord>> {
451
+ const localVarAxiosArgs = await localVarAxiosParamCreator.placeOptionStrategy(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.optionStrategyId, requestParameters.requestBody, options);
452
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
453
+ },
454
+ }
455
+ };
456
+
457
+ /**
458
+ * OptionsApi - factory interface
459
+ * @export
460
+ */
461
+ export const OptionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
462
+ const localVarFp = OptionsApiFp(configuration)
463
+ return {
464
+ /**
465
+ *
466
+ * @summary Creates an option strategy object that will be used to place an option strategy order
467
+ * @param {OptionsApiGetOptionStrategyRequest} requestParameters Request parameters.
468
+ * @param {*} [options] Override http request option.
469
+ * @throws {RequiredError}
470
+ */
471
+ getOptionStrategy(requestParameters: OptionsApiGetOptionStrategyRequest, options?: AxiosRequestConfig): AxiosPromise<StrategyQuotes> {
472
+ return localVarFp.getOptionStrategy(requestParameters, options).then((request) => request(axios, basePath));
473
+ },
474
+ /**
475
+ *
476
+ * @summary Get the options chain
477
+ * @param {OptionsApiGetOptionsChainRequest} requestParameters Request parameters.
478
+ * @param {*} [options] Override http request option.
479
+ * @throws {RequiredError}
480
+ */
481
+ getOptionsChain(requestParameters: OptionsApiGetOptionsChainRequest, options?: AxiosRequestConfig): AxiosPromise<Array<OptionChainInner>> {
482
+ return localVarFp.getOptionsChain(requestParameters, options).then((request) => request(axios, basePath));
483
+ },
484
+ /**
485
+ *
486
+ * @summary Get latest market data of option strategy
487
+ * @param {OptionsApiGetOptionsStrategyQuoteRequest} requestParameters Request parameters.
488
+ * @param {*} [options] Override http request option.
489
+ * @throws {RequiredError}
490
+ */
491
+ getOptionsStrategyQuote(requestParameters: OptionsApiGetOptionsStrategyQuoteRequest, options?: AxiosRequestConfig): AxiosPromise<StrategyQuotes> {
492
+ return localVarFp.getOptionsStrategyQuote(requestParameters, options).then((request) => request(axios, basePath));
493
+ },
494
+ /**
495
+ *
496
+ * @summary Get the options holdings in the account
497
+ * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
498
+ * @param {*} [options] Override http request option.
499
+ * @throws {RequiredError}
500
+ */
501
+ listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<OptionsHoldings> {
502
+ return localVarFp.listOptionHoldings(requestParameters, options).then((request) => request(axios, basePath));
503
+ },
504
+ /**
505
+ *
506
+ * @summary Place an option strategy order on the brokerage
507
+ * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
508
+ * @param {*} [options] Override http request option.
509
+ * @throws {RequiredError}
510
+ */
511
+ placeOptionStrategy(requestParameters: OptionsApiPlaceOptionStrategyRequest, options?: AxiosRequestConfig): AxiosPromise<StrategyOrderRecord> {
512
+ return localVarFp.placeOptionStrategy(requestParameters, options).then((request) => request(axios, basePath));
513
+ },
514
+ };
515
+ };
516
+
517
+ /**
518
+ * Request parameters for getOptionStrategy operation in OptionsApi.
519
+ * @export
520
+ * @interface OptionsApiGetOptionStrategyRequest
521
+ */
522
+ export interface OptionsApiGetOptionStrategyRequest {
523
+ /**
524
+ *
525
+ * @type {string}
526
+ * @memberof OptionsApiGetOptionStrategy
527
+ */
528
+ readonly userId: string
529
+
530
+ /**
531
+ *
532
+ * @type {string}
533
+ * @memberof OptionsApiGetOptionStrategy
534
+ */
535
+ readonly userSecret: string
536
+
537
+ /**
538
+ * The ID of the account get positions.
539
+ * @type {string}
540
+ * @memberof OptionsApiGetOptionStrategy
541
+ */
542
+ readonly accountId: string
543
+
544
+ /**
545
+ *
546
+ * @type {OptionsGetOptionStrategyRequest}
547
+ * @memberof OptionsApiGetOptionStrategy
548
+ */
549
+ readonly requestBody: OptionsGetOptionStrategyRequest
550
+ }
551
+
552
+ /**
553
+ * Request parameters for getOptionsChain operation in OptionsApi.
554
+ * @export
555
+ * @interface OptionsApiGetOptionsChainRequest
556
+ */
557
+ export interface OptionsApiGetOptionsChainRequest {
558
+ /**
559
+ *
560
+ * @type {string}
561
+ * @memberof OptionsApiGetOptionsChain
562
+ */
563
+ readonly userId: string
564
+
565
+ /**
566
+ *
567
+ * @type {string}
568
+ * @memberof OptionsApiGetOptionsChain
569
+ */
570
+ readonly userSecret: string
571
+
572
+ /**
573
+ * The ID of the account get positions.
574
+ * @type {string}
575
+ * @memberof OptionsApiGetOptionsChain
576
+ */
577
+ readonly accountId: string
578
+
579
+ /**
580
+ * Universal symbol ID if symbol
581
+ * @type {string}
582
+ * @memberof OptionsApiGetOptionsChain
583
+ */
584
+ readonly symbol: string
585
+ }
586
+
587
+ /**
588
+ * Request parameters for getOptionsStrategyQuote operation in OptionsApi.
589
+ * @export
590
+ * @interface OptionsApiGetOptionsStrategyQuoteRequest
591
+ */
592
+ export interface OptionsApiGetOptionsStrategyQuoteRequest {
593
+ /**
594
+ *
595
+ * @type {string}
596
+ * @memberof OptionsApiGetOptionsStrategyQuote
597
+ */
598
+ readonly userId: string
599
+
600
+ /**
601
+ *
602
+ * @type {string}
603
+ * @memberof OptionsApiGetOptionsStrategyQuote
604
+ */
605
+ readonly userSecret: string
606
+
607
+ /**
608
+ * The ID of the account get positions.
609
+ * @type {string}
610
+ * @memberof OptionsApiGetOptionsStrategyQuote
611
+ */
612
+ readonly accountId: string
613
+
614
+ /**
615
+ * Option strategy id obtained from response when creating option strategy object
616
+ * @type {string}
617
+ * @memberof OptionsApiGetOptionsStrategyQuote
618
+ */
619
+ readonly optionStrategyId: string
620
+ }
621
+
622
+ /**
623
+ * Request parameters for listOptionHoldings operation in OptionsApi.
624
+ * @export
625
+ * @interface OptionsApiListOptionHoldingsRequest
626
+ */
627
+ export interface OptionsApiListOptionHoldingsRequest {
628
+ /**
629
+ *
630
+ * @type {string}
631
+ * @memberof OptionsApiListOptionHoldings
632
+ */
633
+ readonly userId: string
634
+
635
+ /**
636
+ *
637
+ * @type {string}
638
+ * @memberof OptionsApiListOptionHoldings
639
+ */
640
+ readonly userSecret: string
641
+
642
+ /**
643
+ * The ID of the account get positions.
644
+ * @type {string}
645
+ * @memberof OptionsApiListOptionHoldings
646
+ */
647
+ readonly accountId: string
648
+ }
649
+
650
+ /**
651
+ * Request parameters for placeOptionStrategy operation in OptionsApi.
652
+ * @export
653
+ * @interface OptionsApiPlaceOptionStrategyRequest
654
+ */
655
+ export interface OptionsApiPlaceOptionStrategyRequest {
656
+ /**
657
+ *
658
+ * @type {string}
659
+ * @memberof OptionsApiPlaceOptionStrategy
660
+ */
661
+ readonly userId: string
662
+
663
+ /**
664
+ *
665
+ * @type {string}
666
+ * @memberof OptionsApiPlaceOptionStrategy
667
+ */
668
+ readonly userSecret: string
669
+
670
+ /**
671
+ * The ID of the account get positions.
672
+ * @type {string}
673
+ * @memberof OptionsApiPlaceOptionStrategy
674
+ */
675
+ readonly accountId: string
676
+
677
+ /**
678
+ * Option strategy id obtained from response when creating option strategy object
679
+ * @type {string}
680
+ * @memberof OptionsApiPlaceOptionStrategy
681
+ */
682
+ readonly optionStrategyId: string
683
+
684
+ /**
685
+ *
686
+ * @type {OptionsPlaceOptionStrategyRequest}
687
+ * @memberof OptionsApiPlaceOptionStrategy
688
+ */
689
+ readonly requestBody: OptionsPlaceOptionStrategyRequest
690
+ }
691
+
692
+ /**
693
+ * OptionsApi - object-oriented interface
694
+ * @export
695
+ * @class OptionsApi
696
+ * @extends {BaseAPI}
697
+ */
698
+ export class OptionsApi extends BaseAPI {
699
+ /**
700
+ *
701
+ * @summary Creates an option strategy object that will be used to place an option strategy order
702
+ * @param {OptionsApiGetOptionStrategyRequest} requestParameters Request parameters.
703
+ * @param {*} [options] Override http request option.
704
+ * @throws {RequiredError}
705
+ * @memberof OptionsApi
706
+ */
707
+ public getOptionStrategy(requestParameters: OptionsApiGetOptionStrategyRequest, options?: AxiosRequestConfig) {
708
+ return OptionsApiFp(this.configuration).getOptionStrategy(requestParameters, options).then((request) => request(this.axios, this.basePath));
709
+ }
710
+
711
+ /**
712
+ *
713
+ * @summary Get the options chain
714
+ * @param {OptionsApiGetOptionsChainRequest} requestParameters Request parameters.
715
+ * @param {*} [options] Override http request option.
716
+ * @throws {RequiredError}
717
+ * @memberof OptionsApi
718
+ */
719
+ public getOptionsChain(requestParameters: OptionsApiGetOptionsChainRequest, options?: AxiosRequestConfig) {
720
+ return OptionsApiFp(this.configuration).getOptionsChain(requestParameters, options).then((request) => request(this.axios, this.basePath));
721
+ }
722
+
723
+ /**
724
+ *
725
+ * @summary Get latest market data of option strategy
726
+ * @param {OptionsApiGetOptionsStrategyQuoteRequest} requestParameters Request parameters.
727
+ * @param {*} [options] Override http request option.
728
+ * @throws {RequiredError}
729
+ * @memberof OptionsApi
730
+ */
731
+ public getOptionsStrategyQuote(requestParameters: OptionsApiGetOptionsStrategyQuoteRequest, options?: AxiosRequestConfig) {
732
+ return OptionsApiFp(this.configuration).getOptionsStrategyQuote(requestParameters, options).then((request) => request(this.axios, this.basePath));
733
+ }
734
+
735
+ /**
736
+ *
737
+ * @summary Get the options holdings in the account
738
+ * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
739
+ * @param {*} [options] Override http request option.
740
+ * @throws {RequiredError}
741
+ * @memberof OptionsApi
742
+ */
743
+ public listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig) {
744
+ return OptionsApiFp(this.configuration).listOptionHoldings(requestParameters, options).then((request) => request(this.axios, this.basePath));
745
+ }
746
+
747
+ /**
748
+ *
749
+ * @summary Place an option strategy order on the brokerage
750
+ * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
751
+ * @param {*} [options] Override http request option.
752
+ * @throws {RequiredError}
753
+ * @memberof OptionsApi
754
+ */
755
+ public placeOptionStrategy(requestParameters: OptionsApiPlaceOptionStrategyRequest, options?: AxiosRequestConfig) {
756
+ return OptionsApiFp(this.configuration).placeOptionStrategy(requestParameters, options).then((request) => request(this.axios, this.basePath));
757
+ }
758
+ }