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,1624 @@
1
+ /**
2
+ * SnapTrade
3
+ * Connect brokerage accounts to your app for live positions and trading
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: api@snaptrade.com
7
+ *
8
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
9
+ * https://konfigthis.com
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { Account } from '../models';
16
+ import { Balance } from '../models';
17
+ import { CalculatedTrade } from '../models';
18
+ import { ExcludedAsset } from '../models';
19
+ import { ModelAssetClassDetails } from '../models';
20
+ import { ModelPortfolioDetails } from '../models';
21
+ import { PortfolioGroup } from '../models';
22
+ import { PortfolioGroupInfo } from '../models';
23
+ import { PortfolioGroupPosition } from '../models';
24
+ import { PortfolioGroupSettings } from '../models';
25
+ import { SymbolQuery } from '../models';
26
+ import { TargetAsset } from '../models';
27
+ import { Trade } from '../models';
28
+ import { UniversalSymbol } from '../models';
29
+ /**
30
+ * PortfolioManagementApi - axios parameter creator
31
+ * @export
32
+ */
33
+ export declare const PortfolioManagementApiAxiosParamCreator: (configuration?: Configuration) => {
34
+ /**
35
+ *
36
+ * @summary Adds an asset to exclude to a portfolio group
37
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to exclude an asset.
38
+ * @param {UniversalSymbol} [universalSymbol]
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ addPortfolioExcludedAsset: (portfolioGroupId: string, universalSymbol?: UniversalSymbol, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
+ /**
44
+ *
45
+ * @summary Create new portfolio group
46
+ * @param {string} userId
47
+ * @param {string} userSecret
48
+ * @param {{ [key: string]: any; }} requestBody
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ create: (userId: string, userSecret: string, requestBody: {
53
+ [key: string]: any;
54
+ }, options?: AxiosRequestConfig) => Promise<RequestArgs>;
55
+ /**
56
+ *
57
+ * @summary Create a new model asset class
58
+ * @param {*} [options] Override http request option.
59
+ * @throws {RequiredError}
60
+ */
61
+ createAssetClass: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
62
+ /**
63
+ *
64
+ * @summary Creates a new model portfolio
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ */
68
+ createModelPortfolio: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
+ /**
70
+ *
71
+ * @summary Deletes a model asset class
72
+ * @param {string} modelAssetClassId The ID of the model asset class to delete.
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ deleteAssetClass: (modelAssetClassId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
+ /**
78
+ *
79
+ * @summary Unexclude an asset from a portfolio group
80
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to unexclude an asset.
81
+ * @param {string} symbolId The ID of the excluded asset Symbol to delete.
82
+ * @param {*} [options] Override http request option.
83
+ * @throws {RequiredError}
84
+ */
85
+ deleteExcludedAsset: (portfolioGroupId: string, symbolId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
86
+ /**
87
+ *
88
+ * @summary Deletes a model portfolio
89
+ * @param {string} modelPortfolioId The ID of the model portfolio to delete.
90
+ * @param {*} [options] Override http request option.
91
+ * @throws {RequiredError}
92
+ */
93
+ deleteModelPortfolioById: (modelPortfolioId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
94
+ /**
95
+ *
96
+ * @summary Remove a target portfolio.
97
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup to delete.
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ */
101
+ deletePortfoli: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
102
+ /**
103
+ *
104
+ * @summary Remove a TargetAsset.
105
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to remove the target asset.
106
+ * @param {string} targetAssetId The ID of the TargetAsset to delete.
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ */
110
+ deletePortfolioTargetById: (portfolioGroupId: string, targetAssetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
111
+ /**
112
+ *
113
+ * @summary Get details of a model asset class
114
+ * @param {string} modelAssetClassId The ID of the model asset class to get.
115
+ * @param {*} [options] Override http request option.
116
+ * @throws {RequiredError}
117
+ */
118
+ detailAssetClass: (modelAssetClassId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
119
+ /**
120
+ *
121
+ * @summary Return an individual trade
122
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup to perform rebalancing calculations
123
+ * @param {string} calculatedTradeId The ID of calculated trade to get account impact
124
+ * @param {string} tradeId The ID of trade object
125
+ * @param {*} [options] Override http request option.
126
+ * @throws {RequiredError}
127
+ */
128
+ getCalculatedTradeById: (portfolioGroupId: string, calculatedTradeId: string, tradeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
129
+ /**
130
+ *
131
+ * @summary Get details of a model portfolio
132
+ * @param {string} modelPortfolioId The ID of the model portfolio to get.
133
+ * @param {*} [options] Override http request option.
134
+ * @throws {RequiredError}
135
+ */
136
+ getModelDetailsById: (modelPortfolioId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
137
+ /**
138
+ *
139
+ * @summary Get sum of cash balances in portfolio group
140
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to create the target asset.
141
+ * @param {*} [options] Override http request option.
142
+ * @throws {RequiredError}
143
+ */
144
+ getPortfolioBalances: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
145
+ /**
146
+ *
147
+ * @summary Get details of a target portfolio
148
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup to get.
149
+ * @param {*} [options] Override http request option.
150
+ * @throws {RequiredError}
151
+ */
152
+ getPortfolioDetailsById: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
153
+ /**
154
+ *
155
+ * @summary Return a whole bunch of relevant information relating to a portfolio group.
156
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to create the target asset.
157
+ * @param {*} [options] Override http request option.
158
+ * @throws {RequiredError}
159
+ */
160
+ getPortfolioInfo: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
161
+ /**
162
+ *
163
+ * @summary Get total of each postions owned in portfolio group
164
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to create the target asset.
165
+ * @param {*} [options] Override http request option.
166
+ * @throws {RequiredError}
167
+ */
168
+ getPortfolioPositions: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
169
+ /**
170
+ *
171
+ * @summary Get portfolio group settings
172
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to get the settings.
173
+ * @param {*} [options] Override http request option.
174
+ * @throws {RequiredError}
175
+ */
176
+ getPortfolioSettings: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
177
+ /**
178
+ *
179
+ * @summary Get a specific target from a portfolio group
180
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to get the target asset.
181
+ * @param {string} targetAssetId The ID of the TargetAsset to get.
182
+ * @param {*} [options] Override http request option.
183
+ * @throws {RequiredError}
184
+ */
185
+ getPortfolioTargetById: (portfolioGroupId: string, targetAssetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
186
+ /**
187
+ *
188
+ * @summary Get all target assets under the specified PortfolioGroup.
189
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to create the target asset.
190
+ * @param {*} [options] Override http request option.
191
+ * @throws {RequiredError}
192
+ */
193
+ getPortfolioTargets: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
194
+ /**
195
+ *
196
+ * @summary Get an array of excluded assets associated with a portfolio group\\
197
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which the excluded assets are linked.
198
+ * @param {*} [options] Override http request option.
199
+ * @throws {RequiredError}
200
+ */
201
+ getPortoflioExcludedAssets: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
202
+ /**
203
+ *
204
+ * @summary Import target allocation based on portfolio group
205
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to create the target asset.
206
+ * @param {*} [options] Override http request option.
207
+ * @throws {RequiredError}
208
+ */
209
+ importModelPortfolio: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
210
+ /**
211
+ *
212
+ * @summary List all portfolio groups
213
+ * @param {string} userId
214
+ * @param {string} userSecret
215
+ * @param {*} [options] Override http request option.
216
+ * @throws {RequiredError}
217
+ */
218
+ list: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
219
+ /**
220
+ *
221
+ * @summary List of model asset class
222
+ * @param {*} [options] Override http request option.
223
+ * @throws {RequiredError}
224
+ */
225
+ listAssetClasses: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
226
+ /**
227
+ *
228
+ * @summary List of trades to make to rebalance portfolio group
229
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup to perform rebalancing calculations
230
+ * @param {*} [options] Override http request option.
231
+ * @throws {RequiredError}
232
+ */
233
+ listCalculatedTrades: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
234
+ /**
235
+ *
236
+ * @summary List of model portfolio
237
+ * @param {*} [options] Override http request option.
238
+ * @throws {RequiredError}
239
+ */
240
+ listModelPortfolio: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
241
+ /**
242
+ *
243
+ * @summary Get all accounts associated with a portfolio group
244
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which the accounts are linked.
245
+ * @param {*} [options] Override http request option.
246
+ * @throws {RequiredError}
247
+ */
248
+ listPortfolioAccounts: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
249
+ /**
250
+ *
251
+ * @summary Updates model portfolio object
252
+ * @param {string} modelPortfolioId The ID of the model portfolio to update.
253
+ * @param {ModelPortfolioDetails} modelPortfolioDetails Use this endpoint change model asset class name and to add or remove a model portfolio security/model portfolio asset class. &lt;br /&gt;&lt;br /&gt; * The model portfolio name and model portfolio model type is required. &lt;br /&gt; * The model portfolio model type must be either 0 or 1. [0 -&gt; Securities based, 1 -&gt; Asset Class based] &lt;br /&gt;&lt;br /&gt; * If the model portfolio type is 0, the model portfolio asset class must be an empty array. &lt;br /&gt; * If the model portfolio type is 1, the model portfolio security must be an empty array. &lt;br /&gt;&lt;br /&gt; * When updating the model portfolio security, the percent is required. Only the symbol id is required for the symbol object &lt;br /&gt; * When updating the model portfolio asset classes, the percent is required. Only the model asset class id is required for the model asset class object &lt;br /&gt;&lt;br /&gt; * To remove all model portfolio securities or model portfolio asset class, set then to an empty array
254
+ * @param {*} [options] Override http request option.
255
+ * @throws {RequiredError}
256
+ */
257
+ modifyModelPortfolioById: (modelPortfolioId: string, modelPortfolioDetails: ModelPortfolioDetails, options?: AxiosRequestConfig) => Promise<RequestArgs>;
258
+ /**
259
+ *
260
+ * @summary Update an existing target portfolio.
261
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup to update.
262
+ * @param {{ [key: string]: any; }} requestBody
263
+ * @param {*} [options] Override http request option.
264
+ * @throws {RequiredError}
265
+ */
266
+ savePortfolio: (portfolioGroupId: string, requestBody: {
267
+ [key: string]: any;
268
+ }, options?: AxiosRequestConfig) => Promise<RequestArgs>;
269
+ /**
270
+ *
271
+ * @summary Search for symbols limited to brokerages under the specified portfolio group
272
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup to search under
273
+ * @param {SymbolQuery} [symbolQuery]
274
+ * @param {*} [options] Override http request option.
275
+ * @throws {RequiredError}
276
+ */
277
+ searchPortfolioSymbols: (portfolioGroupId: string, symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
278
+ /**
279
+ *
280
+ * @summary Set a new list of target assets under the specified PortfolioGroup. All existing target assets under this portfolio group will be replaced with the new list.
281
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to create the target asset.
282
+ * @param {Array<TargetAsset>} [targetAsset]
283
+ * @param {*} [options] Override http request option.
284
+ * @throws {RequiredError}
285
+ */
286
+ setPortfolioTargets: (portfolioGroupId: string, targetAsset?: Array<TargetAsset>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
287
+ /**
288
+ *
289
+ * @summary Updates model asset class objects
290
+ * @param {string} modelAssetClassId The ID of the model asset class to update.
291
+ * @param {ModelAssetClassDetails} modelAssetClassDetails Use this endpoint change model asset class name and to add or remove a model asset class target. &lt;br /&gt;&lt;br /&gt; * Only the model asset class name is required for the model asset class object. &lt;br /&gt; * Only the symbol id is required for the symbol object in the model asset class target object. &lt;br /&gt; * To remove all model asset class targets, set the model asset class target as an empty array
292
+ * @param {*} [options] Override http request option.
293
+ * @throws {RequiredError}
294
+ */
295
+ updateAssetClass: (modelAssetClassId: string, modelAssetClassDetails: ModelAssetClassDetails, options?: AxiosRequestConfig) => Promise<RequestArgs>;
296
+ /**
297
+ *
298
+ * @summary Updates portfolio group settings
299
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to patch the settings.
300
+ * @param {*} [options] Override http request option.
301
+ * @throws {RequiredError}
302
+ */
303
+ updatePortfolioSettings: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
304
+ /**
305
+ *
306
+ * @summary Update a TargetAsset under the specified PortfolioGroup.
307
+ * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to patch the target asset.
308
+ * @param {string} targetAssetId The ID of the TargetAsset to patch.
309
+ * @param {TargetAsset} targetAsset
310
+ * @param {*} [options] Override http request option.
311
+ * @throws {RequiredError}
312
+ */
313
+ updatePortfolioTargetById: (portfolioGroupId: string, targetAssetId: string, targetAsset: TargetAsset, options?: AxiosRequestConfig) => Promise<RequestArgs>;
314
+ };
315
+ /**
316
+ * PortfolioManagementApi - functional programming interface
317
+ * @export
318
+ */
319
+ export declare const PortfolioManagementApiFp: (configuration?: Configuration) => {
320
+ /**
321
+ *
322
+ * @summary Adds an asset to exclude to a portfolio group
323
+ * @param {PortfolioManagementApiAddPortfolioExcludedAssetRequest} requestParameters Request parameters.
324
+ * @param {*} [options] Override http request option.
325
+ * @throws {RequiredError}
326
+ */
327
+ addPortfolioExcludedAsset(requestParameters: PortfolioManagementApiAddPortfolioExcludedAssetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExcludedAsset>>;
328
+ /**
329
+ *
330
+ * @summary Create new portfolio group
331
+ * @param {PortfolioManagementApiCreateRequest} requestParameters Request parameters.
332
+ * @param {*} [options] Override http request option.
333
+ * @throws {RequiredError}
334
+ */
335
+ create(requestParameters: PortfolioManagementApiCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioGroup>>>;
336
+ /**
337
+ *
338
+ * @summary Create a new model asset class
339
+ * @param {*} [options] Override http request option.
340
+ * @throws {RequiredError}
341
+ */
342
+ createAssetClass(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModelAssetClassDetails>>;
343
+ /**
344
+ *
345
+ * @summary Creates a new model portfolio
346
+ * @param {*} [options] Override http request option.
347
+ * @throws {RequiredError}
348
+ */
349
+ createModelPortfolio(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModelPortfolioDetails>>;
350
+ /**
351
+ *
352
+ * @summary Deletes a model asset class
353
+ * @param {PortfolioManagementApiDeleteAssetClassRequest} requestParameters Request parameters.
354
+ * @param {*} [options] Override http request option.
355
+ * @throws {RequiredError}
356
+ */
357
+ deleteAssetClass(requestParameters: PortfolioManagementApiDeleteAssetClassRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
358
+ /**
359
+ *
360
+ * @summary Unexclude an asset from a portfolio group
361
+ * @param {PortfolioManagementApiDeleteExcludedAssetRequest} requestParameters Request parameters.
362
+ * @param {*} [options] Override http request option.
363
+ * @throws {RequiredError}
364
+ */
365
+ deleteExcludedAsset(requestParameters: PortfolioManagementApiDeleteExcludedAssetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
366
+ /**
367
+ *
368
+ * @summary Deletes a model portfolio
369
+ * @param {PortfolioManagementApiDeleteModelPortfolioByIdRequest} requestParameters Request parameters.
370
+ * @param {*} [options] Override http request option.
371
+ * @throws {RequiredError}
372
+ */
373
+ deleteModelPortfolioById(requestParameters: PortfolioManagementApiDeleteModelPortfolioByIdRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
374
+ /**
375
+ *
376
+ * @summary Remove a target portfolio.
377
+ * @param {PortfolioManagementApiDeletePortfoliRequest} requestParameters Request parameters.
378
+ * @param {*} [options] Override http request option.
379
+ * @throws {RequiredError}
380
+ */
381
+ deletePortfoli(requestParameters: PortfolioManagementApiDeletePortfoliRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioGroup>>;
382
+ /**
383
+ *
384
+ * @summary Remove a TargetAsset.
385
+ * @param {PortfolioManagementApiDeletePortfolioTargetByIdRequest} requestParameters Request parameters.
386
+ * @param {*} [options] Override http request option.
387
+ * @throws {RequiredError}
388
+ */
389
+ deletePortfolioTargetById(requestParameters: PortfolioManagementApiDeletePortfolioTargetByIdRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TargetAsset>>;
390
+ /**
391
+ *
392
+ * @summary Get details of a model asset class
393
+ * @param {PortfolioManagementApiDetailAssetClassRequest} requestParameters Request parameters.
394
+ * @param {*} [options] Override http request option.
395
+ * @throws {RequiredError}
396
+ */
397
+ detailAssetClass(requestParameters: PortfolioManagementApiDetailAssetClassRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModelAssetClassDetails>>;
398
+ /**
399
+ *
400
+ * @summary Return an individual trade
401
+ * @param {PortfolioManagementApiGetCalculatedTradeByIdRequest} requestParameters Request parameters.
402
+ * @param {*} [options] Override http request option.
403
+ * @throws {RequiredError}
404
+ */
405
+ getCalculatedTradeById(requestParameters: PortfolioManagementApiGetCalculatedTradeByIdRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Trade>>>;
406
+ /**
407
+ *
408
+ * @summary Get details of a model portfolio
409
+ * @param {PortfolioManagementApiGetModelDetailsByIdRequest} requestParameters Request parameters.
410
+ * @param {*} [options] Override http request option.
411
+ * @throws {RequiredError}
412
+ */
413
+ getModelDetailsById(requestParameters: PortfolioManagementApiGetModelDetailsByIdRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModelPortfolioDetails>>;
414
+ /**
415
+ *
416
+ * @summary Get sum of cash balances in portfolio group
417
+ * @param {PortfolioManagementApiGetPortfolioBalancesRequest} requestParameters Request parameters.
418
+ * @param {*} [options] Override http request option.
419
+ * @throws {RequiredError}
420
+ */
421
+ getPortfolioBalances(requestParameters: PortfolioManagementApiGetPortfolioBalancesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Balance>>>;
422
+ /**
423
+ *
424
+ * @summary Get details of a target portfolio
425
+ * @param {PortfolioManagementApiGetPortfolioDetailsByIdRequest} requestParameters Request parameters.
426
+ * @param {*} [options] Override http request option.
427
+ * @throws {RequiredError}
428
+ */
429
+ getPortfolioDetailsById(requestParameters: PortfolioManagementApiGetPortfolioDetailsByIdRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioGroup>>;
430
+ /**
431
+ *
432
+ * @summary Return a whole bunch of relevant information relating to a portfolio group.
433
+ * @param {PortfolioManagementApiGetPortfolioInfoRequest} requestParameters Request parameters.
434
+ * @param {*} [options] Override http request option.
435
+ * @throws {RequiredError}
436
+ */
437
+ getPortfolioInfo(requestParameters: PortfolioManagementApiGetPortfolioInfoRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioGroupInfo>>;
438
+ /**
439
+ *
440
+ * @summary Get total of each postions owned in portfolio group
441
+ * @param {PortfolioManagementApiGetPortfolioPositionsRequest} requestParameters Request parameters.
442
+ * @param {*} [options] Override http request option.
443
+ * @throws {RequiredError}
444
+ */
445
+ getPortfolioPositions(requestParameters: PortfolioManagementApiGetPortfolioPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioGroupPosition>>>;
446
+ /**
447
+ *
448
+ * @summary Get portfolio group settings
449
+ * @param {PortfolioManagementApiGetPortfolioSettingsRequest} requestParameters Request parameters.
450
+ * @param {*} [options] Override http request option.
451
+ * @throws {RequiredError}
452
+ */
453
+ getPortfolioSettings(requestParameters: PortfolioManagementApiGetPortfolioSettingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioGroupSettings>>;
454
+ /**
455
+ *
456
+ * @summary Get a specific target from a portfolio group
457
+ * @param {PortfolioManagementApiGetPortfolioTargetByIdRequest} requestParameters Request parameters.
458
+ * @param {*} [options] Override http request option.
459
+ * @throws {RequiredError}
460
+ */
461
+ getPortfolioTargetById(requestParameters: PortfolioManagementApiGetPortfolioTargetByIdRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TargetAsset>>;
462
+ /**
463
+ *
464
+ * @summary Get all target assets under the specified PortfolioGroup.
465
+ * @param {PortfolioManagementApiGetPortfolioTargetsRequest} requestParameters Request parameters.
466
+ * @param {*} [options] Override http request option.
467
+ * @throws {RequiredError}
468
+ */
469
+ getPortfolioTargets(requestParameters: PortfolioManagementApiGetPortfolioTargetsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TargetAsset>>>;
470
+ /**
471
+ *
472
+ * @summary Get an array of excluded assets associated with a portfolio group\\
473
+ * @param {PortfolioManagementApiGetPortoflioExcludedAssetsRequest} requestParameters Request parameters.
474
+ * @param {*} [options] Override http request option.
475
+ * @throws {RequiredError}
476
+ */
477
+ getPortoflioExcludedAssets(requestParameters: PortfolioManagementApiGetPortoflioExcludedAssetsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExcludedAsset>>>;
478
+ /**
479
+ *
480
+ * @summary Import target allocation based on portfolio group
481
+ * @param {PortfolioManagementApiImportModelPortfolioRequest} requestParameters Request parameters.
482
+ * @param {*} [options] Override http request option.
483
+ * @throws {RequiredError}
484
+ */
485
+ importModelPortfolio(requestParameters: PortfolioManagementApiImportModelPortfolioRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TargetAsset>>>;
486
+ /**
487
+ *
488
+ * @summary List all portfolio groups
489
+ * @param {PortfolioManagementApiListRequest} requestParameters Request parameters.
490
+ * @param {*} [options] Override http request option.
491
+ * @throws {RequiredError}
492
+ */
493
+ list(requestParameters: PortfolioManagementApiListRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioGroup>>>;
494
+ /**
495
+ *
496
+ * @summary List of model asset class
497
+ * @param {*} [options] Override http request option.
498
+ * @throws {RequiredError}
499
+ */
500
+ listAssetClasses(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ModelAssetClassDetails>>>;
501
+ /**
502
+ *
503
+ * @summary List of trades to make to rebalance portfolio group
504
+ * @param {PortfolioManagementApiListCalculatedTradesRequest} requestParameters Request parameters.
505
+ * @param {*} [options] Override http request option.
506
+ * @throws {RequiredError}
507
+ */
508
+ listCalculatedTrades(requestParameters: PortfolioManagementApiListCalculatedTradesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CalculatedTrade>>;
509
+ /**
510
+ *
511
+ * @summary List of model portfolio
512
+ * @param {*} [options] Override http request option.
513
+ * @throws {RequiredError}
514
+ */
515
+ listModelPortfolio(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ModelPortfolioDetails>>>;
516
+ /**
517
+ *
518
+ * @summary Get all accounts associated with a portfolio group
519
+ * @param {PortfolioManagementApiListPortfolioAccountsRequest} requestParameters Request parameters.
520
+ * @param {*} [options] Override http request option.
521
+ * @throws {RequiredError}
522
+ */
523
+ listPortfolioAccounts(requestParameters: PortfolioManagementApiListPortfolioAccountsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
524
+ /**
525
+ *
526
+ * @summary Updates model portfolio object
527
+ * @param {PortfolioManagementApiModifyModelPortfolioByIdRequest} requestParameters Request parameters.
528
+ * @param {*} [options] Override http request option.
529
+ * @throws {RequiredError}
530
+ */
531
+ modifyModelPortfolioById(requestParameters: PortfolioManagementApiModifyModelPortfolioByIdRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
532
+ /**
533
+ *
534
+ * @summary Update an existing target portfolio.
535
+ * @param {PortfolioManagementApiSavePortfolioRequest} requestParameters Request parameters.
536
+ * @param {*} [options] Override http request option.
537
+ * @throws {RequiredError}
538
+ */
539
+ savePortfolio(requestParameters: PortfolioManagementApiSavePortfolioRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioGroup>>;
540
+ /**
541
+ *
542
+ * @summary Search for symbols limited to brokerages under the specified portfolio group
543
+ * @param {PortfolioManagementApiSearchPortfolioSymbolsRequest} requestParameters Request parameters.
544
+ * @param {*} [options] Override http request option.
545
+ * @throws {RequiredError}
546
+ */
547
+ searchPortfolioSymbols(requestParameters: PortfolioManagementApiSearchPortfolioSymbolsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
548
+ /**
549
+ *
550
+ * @summary Set a new list of target assets under the specified PortfolioGroup. All existing target assets under this portfolio group will be replaced with the new list.
551
+ * @param {PortfolioManagementApiSetPortfolioTargetsRequest} requestParameters Request parameters.
552
+ * @param {*} [options] Override http request option.
553
+ * @throws {RequiredError}
554
+ */
555
+ setPortfolioTargets(requestParameters: PortfolioManagementApiSetPortfolioTargetsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TargetAsset>>>;
556
+ /**
557
+ *
558
+ * @summary Updates model asset class objects
559
+ * @param {PortfolioManagementApiUpdateAssetClassRequest} requestParameters Request parameters.
560
+ * @param {*} [options] Override http request option.
561
+ * @throws {RequiredError}
562
+ */
563
+ updateAssetClass(requestParameters: PortfolioManagementApiUpdateAssetClassRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
564
+ /**
565
+ *
566
+ * @summary Updates portfolio group settings
567
+ * @param {PortfolioManagementApiUpdatePortfolioSettingsRequest} requestParameters Request parameters.
568
+ * @param {*} [options] Override http request option.
569
+ * @throws {RequiredError}
570
+ */
571
+ updatePortfolioSettings(requestParameters: PortfolioManagementApiUpdatePortfolioSettingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioGroupSettings>>;
572
+ /**
573
+ *
574
+ * @summary Update a TargetAsset under the specified PortfolioGroup.
575
+ * @param {PortfolioManagementApiUpdatePortfolioTargetByIdRequest} requestParameters Request parameters.
576
+ * @param {*} [options] Override http request option.
577
+ * @throws {RequiredError}
578
+ */
579
+ updatePortfolioTargetById(requestParameters: PortfolioManagementApiUpdatePortfolioTargetByIdRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TargetAsset>>;
580
+ };
581
+ /**
582
+ * PortfolioManagementApi - factory interface
583
+ * @export
584
+ */
585
+ export declare const PortfolioManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
586
+ /**
587
+ *
588
+ * @summary Adds an asset to exclude to a portfolio group
589
+ * @param {PortfolioManagementApiAddPortfolioExcludedAssetRequest} requestParameters Request parameters.
590
+ * @param {*} [options] Override http request option.
591
+ * @throws {RequiredError}
592
+ */
593
+ addPortfolioExcludedAsset(requestParameters: PortfolioManagementApiAddPortfolioExcludedAssetRequest, options?: AxiosRequestConfig): AxiosPromise<ExcludedAsset>;
594
+ /**
595
+ *
596
+ * @summary Create new portfolio group
597
+ * @param {PortfolioManagementApiCreateRequest} requestParameters Request parameters.
598
+ * @param {*} [options] Override http request option.
599
+ * @throws {RequiredError}
600
+ */
601
+ create(requestParameters: PortfolioManagementApiCreateRequest, options?: AxiosRequestConfig): AxiosPromise<Array<PortfolioGroup>>;
602
+ /**
603
+ *
604
+ * @summary Create a new model asset class
605
+ * @param {*} [options] Override http request option.
606
+ * @throws {RequiredError}
607
+ */
608
+ createAssetClass(options?: AxiosRequestConfig): AxiosPromise<ModelAssetClassDetails>;
609
+ /**
610
+ *
611
+ * @summary Creates a new model portfolio
612
+ * @param {*} [options] Override http request option.
613
+ * @throws {RequiredError}
614
+ */
615
+ createModelPortfolio(options?: AxiosRequestConfig): AxiosPromise<ModelPortfolioDetails>;
616
+ /**
617
+ *
618
+ * @summary Deletes a model asset class
619
+ * @param {PortfolioManagementApiDeleteAssetClassRequest} requestParameters Request parameters.
620
+ * @param {*} [options] Override http request option.
621
+ * @throws {RequiredError}
622
+ */
623
+ deleteAssetClass(requestParameters: PortfolioManagementApiDeleteAssetClassRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
624
+ /**
625
+ *
626
+ * @summary Unexclude an asset from a portfolio group
627
+ * @param {PortfolioManagementApiDeleteExcludedAssetRequest} requestParameters Request parameters.
628
+ * @param {*} [options] Override http request option.
629
+ * @throws {RequiredError}
630
+ */
631
+ deleteExcludedAsset(requestParameters: PortfolioManagementApiDeleteExcludedAssetRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
632
+ /**
633
+ *
634
+ * @summary Deletes a model portfolio
635
+ * @param {PortfolioManagementApiDeleteModelPortfolioByIdRequest} requestParameters Request parameters.
636
+ * @param {*} [options] Override http request option.
637
+ * @throws {RequiredError}
638
+ */
639
+ deleteModelPortfolioById(requestParameters: PortfolioManagementApiDeleteModelPortfolioByIdRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
640
+ /**
641
+ *
642
+ * @summary Remove a target portfolio.
643
+ * @param {PortfolioManagementApiDeletePortfoliRequest} requestParameters Request parameters.
644
+ * @param {*} [options] Override http request option.
645
+ * @throws {RequiredError}
646
+ */
647
+ deletePortfoli(requestParameters: PortfolioManagementApiDeletePortfoliRequest, options?: AxiosRequestConfig): AxiosPromise<PortfolioGroup>;
648
+ /**
649
+ *
650
+ * @summary Remove a TargetAsset.
651
+ * @param {PortfolioManagementApiDeletePortfolioTargetByIdRequest} requestParameters Request parameters.
652
+ * @param {*} [options] Override http request option.
653
+ * @throws {RequiredError}
654
+ */
655
+ deletePortfolioTargetById(requestParameters: PortfolioManagementApiDeletePortfolioTargetByIdRequest, options?: AxiosRequestConfig): AxiosPromise<TargetAsset>;
656
+ /**
657
+ *
658
+ * @summary Get details of a model asset class
659
+ * @param {PortfolioManagementApiDetailAssetClassRequest} requestParameters Request parameters.
660
+ * @param {*} [options] Override http request option.
661
+ * @throws {RequiredError}
662
+ */
663
+ detailAssetClass(requestParameters: PortfolioManagementApiDetailAssetClassRequest, options?: AxiosRequestConfig): AxiosPromise<ModelAssetClassDetails>;
664
+ /**
665
+ *
666
+ * @summary Return an individual trade
667
+ * @param {PortfolioManagementApiGetCalculatedTradeByIdRequest} requestParameters Request parameters.
668
+ * @param {*} [options] Override http request option.
669
+ * @throws {RequiredError}
670
+ */
671
+ getCalculatedTradeById(requestParameters: PortfolioManagementApiGetCalculatedTradeByIdRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Trade>>;
672
+ /**
673
+ *
674
+ * @summary Get details of a model portfolio
675
+ * @param {PortfolioManagementApiGetModelDetailsByIdRequest} requestParameters Request parameters.
676
+ * @param {*} [options] Override http request option.
677
+ * @throws {RequiredError}
678
+ */
679
+ getModelDetailsById(requestParameters: PortfolioManagementApiGetModelDetailsByIdRequest, options?: AxiosRequestConfig): AxiosPromise<ModelPortfolioDetails>;
680
+ /**
681
+ *
682
+ * @summary Get sum of cash balances in portfolio group
683
+ * @param {PortfolioManagementApiGetPortfolioBalancesRequest} requestParameters Request parameters.
684
+ * @param {*} [options] Override http request option.
685
+ * @throws {RequiredError}
686
+ */
687
+ getPortfolioBalances(requestParameters: PortfolioManagementApiGetPortfolioBalancesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Balance>>;
688
+ /**
689
+ *
690
+ * @summary Get details of a target portfolio
691
+ * @param {PortfolioManagementApiGetPortfolioDetailsByIdRequest} requestParameters Request parameters.
692
+ * @param {*} [options] Override http request option.
693
+ * @throws {RequiredError}
694
+ */
695
+ getPortfolioDetailsById(requestParameters: PortfolioManagementApiGetPortfolioDetailsByIdRequest, options?: AxiosRequestConfig): AxiosPromise<PortfolioGroup>;
696
+ /**
697
+ *
698
+ * @summary Return a whole bunch of relevant information relating to a portfolio group.
699
+ * @param {PortfolioManagementApiGetPortfolioInfoRequest} requestParameters Request parameters.
700
+ * @param {*} [options] Override http request option.
701
+ * @throws {RequiredError}
702
+ */
703
+ getPortfolioInfo(requestParameters: PortfolioManagementApiGetPortfolioInfoRequest, options?: AxiosRequestConfig): AxiosPromise<PortfolioGroupInfo>;
704
+ /**
705
+ *
706
+ * @summary Get total of each postions owned in portfolio group
707
+ * @param {PortfolioManagementApiGetPortfolioPositionsRequest} requestParameters Request parameters.
708
+ * @param {*} [options] Override http request option.
709
+ * @throws {RequiredError}
710
+ */
711
+ getPortfolioPositions(requestParameters: PortfolioManagementApiGetPortfolioPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<PortfolioGroupPosition>>;
712
+ /**
713
+ *
714
+ * @summary Get portfolio group settings
715
+ * @param {PortfolioManagementApiGetPortfolioSettingsRequest} requestParameters Request parameters.
716
+ * @param {*} [options] Override http request option.
717
+ * @throws {RequiredError}
718
+ */
719
+ getPortfolioSettings(requestParameters: PortfolioManagementApiGetPortfolioSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<PortfolioGroupSettings>;
720
+ /**
721
+ *
722
+ * @summary Get a specific target from a portfolio group
723
+ * @param {PortfolioManagementApiGetPortfolioTargetByIdRequest} requestParameters Request parameters.
724
+ * @param {*} [options] Override http request option.
725
+ * @throws {RequiredError}
726
+ */
727
+ getPortfolioTargetById(requestParameters: PortfolioManagementApiGetPortfolioTargetByIdRequest, options?: AxiosRequestConfig): AxiosPromise<TargetAsset>;
728
+ /**
729
+ *
730
+ * @summary Get all target assets under the specified PortfolioGroup.
731
+ * @param {PortfolioManagementApiGetPortfolioTargetsRequest} requestParameters Request parameters.
732
+ * @param {*} [options] Override http request option.
733
+ * @throws {RequiredError}
734
+ */
735
+ getPortfolioTargets(requestParameters: PortfolioManagementApiGetPortfolioTargetsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<TargetAsset>>;
736
+ /**
737
+ *
738
+ * @summary Get an array of excluded assets associated with a portfolio group\\
739
+ * @param {PortfolioManagementApiGetPortoflioExcludedAssetsRequest} requestParameters Request parameters.
740
+ * @param {*} [options] Override http request option.
741
+ * @throws {RequiredError}
742
+ */
743
+ getPortoflioExcludedAssets(requestParameters: PortfolioManagementApiGetPortoflioExcludedAssetsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<ExcludedAsset>>;
744
+ /**
745
+ *
746
+ * @summary Import target allocation based on portfolio group
747
+ * @param {PortfolioManagementApiImportModelPortfolioRequest} requestParameters Request parameters.
748
+ * @param {*} [options] Override http request option.
749
+ * @throws {RequiredError}
750
+ */
751
+ importModelPortfolio(requestParameters: PortfolioManagementApiImportModelPortfolioRequest, options?: AxiosRequestConfig): AxiosPromise<Array<TargetAsset>>;
752
+ /**
753
+ *
754
+ * @summary List all portfolio groups
755
+ * @param {PortfolioManagementApiListRequest} requestParameters Request parameters.
756
+ * @param {*} [options] Override http request option.
757
+ * @throws {RequiredError}
758
+ */
759
+ list(requestParameters: PortfolioManagementApiListRequest, options?: AxiosRequestConfig): AxiosPromise<Array<PortfolioGroup>>;
760
+ /**
761
+ *
762
+ * @summary List of model asset class
763
+ * @param {*} [options] Override http request option.
764
+ * @throws {RequiredError}
765
+ */
766
+ listAssetClasses(options?: AxiosRequestConfig): AxiosPromise<Array<ModelAssetClassDetails>>;
767
+ /**
768
+ *
769
+ * @summary List of trades to make to rebalance portfolio group
770
+ * @param {PortfolioManagementApiListCalculatedTradesRequest} requestParameters Request parameters.
771
+ * @param {*} [options] Override http request option.
772
+ * @throws {RequiredError}
773
+ */
774
+ listCalculatedTrades(requestParameters: PortfolioManagementApiListCalculatedTradesRequest, options?: AxiosRequestConfig): AxiosPromise<CalculatedTrade>;
775
+ /**
776
+ *
777
+ * @summary List of model portfolio
778
+ * @param {*} [options] Override http request option.
779
+ * @throws {RequiredError}
780
+ */
781
+ listModelPortfolio(options?: AxiosRequestConfig): AxiosPromise<Array<ModelPortfolioDetails>>;
782
+ /**
783
+ *
784
+ * @summary Get all accounts associated with a portfolio group
785
+ * @param {PortfolioManagementApiListPortfolioAccountsRequest} requestParameters Request parameters.
786
+ * @param {*} [options] Override http request option.
787
+ * @throws {RequiredError}
788
+ */
789
+ listPortfolioAccounts(requestParameters: PortfolioManagementApiListPortfolioAccountsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Account>>;
790
+ /**
791
+ *
792
+ * @summary Updates model portfolio object
793
+ * @param {PortfolioManagementApiModifyModelPortfolioByIdRequest} requestParameters Request parameters.
794
+ * @param {*} [options] Override http request option.
795
+ * @throws {RequiredError}
796
+ */
797
+ modifyModelPortfolioById(requestParameters: PortfolioManagementApiModifyModelPortfolioByIdRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
798
+ /**
799
+ *
800
+ * @summary Update an existing target portfolio.
801
+ * @param {PortfolioManagementApiSavePortfolioRequest} requestParameters Request parameters.
802
+ * @param {*} [options] Override http request option.
803
+ * @throws {RequiredError}
804
+ */
805
+ savePortfolio(requestParameters: PortfolioManagementApiSavePortfolioRequest, options?: AxiosRequestConfig): AxiosPromise<PortfolioGroup>;
806
+ /**
807
+ *
808
+ * @summary Search for symbols limited to brokerages under the specified portfolio group
809
+ * @param {PortfolioManagementApiSearchPortfolioSymbolsRequest} requestParameters Request parameters.
810
+ * @param {*} [options] Override http request option.
811
+ * @throws {RequiredError}
812
+ */
813
+ searchPortfolioSymbols(requestParameters: PortfolioManagementApiSearchPortfolioSymbolsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
814
+ /**
815
+ *
816
+ * @summary Set a new list of target assets under the specified PortfolioGroup. All existing target assets under this portfolio group will be replaced with the new list.
817
+ * @param {PortfolioManagementApiSetPortfolioTargetsRequest} requestParameters Request parameters.
818
+ * @param {*} [options] Override http request option.
819
+ * @throws {RequiredError}
820
+ */
821
+ setPortfolioTargets(requestParameters: PortfolioManagementApiSetPortfolioTargetsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<TargetAsset>>;
822
+ /**
823
+ *
824
+ * @summary Updates model asset class objects
825
+ * @param {PortfolioManagementApiUpdateAssetClassRequest} requestParameters Request parameters.
826
+ * @param {*} [options] Override http request option.
827
+ * @throws {RequiredError}
828
+ */
829
+ updateAssetClass(requestParameters: PortfolioManagementApiUpdateAssetClassRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
830
+ /**
831
+ *
832
+ * @summary Updates portfolio group settings
833
+ * @param {PortfolioManagementApiUpdatePortfolioSettingsRequest} requestParameters Request parameters.
834
+ * @param {*} [options] Override http request option.
835
+ * @throws {RequiredError}
836
+ */
837
+ updatePortfolioSettings(requestParameters: PortfolioManagementApiUpdatePortfolioSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<PortfolioGroupSettings>;
838
+ /**
839
+ *
840
+ * @summary Update a TargetAsset under the specified PortfolioGroup.
841
+ * @param {PortfolioManagementApiUpdatePortfolioTargetByIdRequest} requestParameters Request parameters.
842
+ * @param {*} [options] Override http request option.
843
+ * @throws {RequiredError}
844
+ */
845
+ updatePortfolioTargetById(requestParameters: PortfolioManagementApiUpdatePortfolioTargetByIdRequest, options?: AxiosRequestConfig): AxiosPromise<TargetAsset>;
846
+ };
847
+ /**
848
+ * Request parameters for addPortfolioExcludedAsset operation in PortfolioManagementApi.
849
+ * @export
850
+ * @interface PortfolioManagementApiAddPortfolioExcludedAssetRequest
851
+ */
852
+ export interface PortfolioManagementApiAddPortfolioExcludedAssetRequest {
853
+ /**
854
+ * The ID of the PortfolioGroup under which to exclude an asset.
855
+ * @type {string}
856
+ * @memberof PortfolioManagementApiAddPortfolioExcludedAsset
857
+ */
858
+ readonly portfolioGroupId: string;
859
+ /**
860
+ *
861
+ * @type {UniversalSymbol}
862
+ * @memberof PortfolioManagementApiAddPortfolioExcludedAsset
863
+ */
864
+ readonly requestBody?: UniversalSymbol;
865
+ }
866
+ /**
867
+ * Request parameters for create operation in PortfolioManagementApi.
868
+ * @export
869
+ * @interface PortfolioManagementApiCreateRequest
870
+ */
871
+ export interface PortfolioManagementApiCreateRequest {
872
+ /**
873
+ *
874
+ * @type {string}
875
+ * @memberof PortfolioManagementApiCreate
876
+ */
877
+ readonly userId: string;
878
+ /**
879
+ *
880
+ * @type {string}
881
+ * @memberof PortfolioManagementApiCreate
882
+ */
883
+ readonly userSecret: string;
884
+ /**
885
+ *
886
+ * @type {{ [key: string]: any; }}
887
+ * @memberof PortfolioManagementApiCreate
888
+ */
889
+ readonly requestBody: {
890
+ [key: string]: any;
891
+ };
892
+ }
893
+ /**
894
+ * Request parameters for deleteAssetClass operation in PortfolioManagementApi.
895
+ * @export
896
+ * @interface PortfolioManagementApiDeleteAssetClassRequest
897
+ */
898
+ export interface PortfolioManagementApiDeleteAssetClassRequest {
899
+ /**
900
+ * The ID of the model asset class to delete.
901
+ * @type {string}
902
+ * @memberof PortfolioManagementApiDeleteAssetClass
903
+ */
904
+ readonly modelAssetClassId: string;
905
+ }
906
+ /**
907
+ * Request parameters for deleteExcludedAsset operation in PortfolioManagementApi.
908
+ * @export
909
+ * @interface PortfolioManagementApiDeleteExcludedAssetRequest
910
+ */
911
+ export interface PortfolioManagementApiDeleteExcludedAssetRequest {
912
+ /**
913
+ * The ID of the PortfolioGroup under which to unexclude an asset.
914
+ * @type {string}
915
+ * @memberof PortfolioManagementApiDeleteExcludedAsset
916
+ */
917
+ readonly portfolioGroupId: string;
918
+ /**
919
+ * The ID of the excluded asset Symbol to delete.
920
+ * @type {string}
921
+ * @memberof PortfolioManagementApiDeleteExcludedAsset
922
+ */
923
+ readonly symbolId: string;
924
+ }
925
+ /**
926
+ * Request parameters for deleteModelPortfolioById operation in PortfolioManagementApi.
927
+ * @export
928
+ * @interface PortfolioManagementApiDeleteModelPortfolioByIdRequest
929
+ */
930
+ export interface PortfolioManagementApiDeleteModelPortfolioByIdRequest {
931
+ /**
932
+ * The ID of the model portfolio to delete.
933
+ * @type {string}
934
+ * @memberof PortfolioManagementApiDeleteModelPortfolioById
935
+ */
936
+ readonly modelPortfolioId: string;
937
+ }
938
+ /**
939
+ * Request parameters for deletePortfoli operation in PortfolioManagementApi.
940
+ * @export
941
+ * @interface PortfolioManagementApiDeletePortfoliRequest
942
+ */
943
+ export interface PortfolioManagementApiDeletePortfoliRequest {
944
+ /**
945
+ * The ID of the PortfolioGroup to delete.
946
+ * @type {string}
947
+ * @memberof PortfolioManagementApiDeletePortfoli
948
+ */
949
+ readonly portfolioGroupId: string;
950
+ }
951
+ /**
952
+ * Request parameters for deletePortfolioTargetById operation in PortfolioManagementApi.
953
+ * @export
954
+ * @interface PortfolioManagementApiDeletePortfolioTargetByIdRequest
955
+ */
956
+ export interface PortfolioManagementApiDeletePortfolioTargetByIdRequest {
957
+ /**
958
+ * The ID of the PortfolioGroup under which to remove the target asset.
959
+ * @type {string}
960
+ * @memberof PortfolioManagementApiDeletePortfolioTargetById
961
+ */
962
+ readonly portfolioGroupId: string;
963
+ /**
964
+ * The ID of the TargetAsset to delete.
965
+ * @type {string}
966
+ * @memberof PortfolioManagementApiDeletePortfolioTargetById
967
+ */
968
+ readonly targetAssetId: string;
969
+ }
970
+ /**
971
+ * Request parameters for detailAssetClass operation in PortfolioManagementApi.
972
+ * @export
973
+ * @interface PortfolioManagementApiDetailAssetClassRequest
974
+ */
975
+ export interface PortfolioManagementApiDetailAssetClassRequest {
976
+ /**
977
+ * The ID of the model asset class to get.
978
+ * @type {string}
979
+ * @memberof PortfolioManagementApiDetailAssetClass
980
+ */
981
+ readonly modelAssetClassId: string;
982
+ }
983
+ /**
984
+ * Request parameters for getCalculatedTradeById operation in PortfolioManagementApi.
985
+ * @export
986
+ * @interface PortfolioManagementApiGetCalculatedTradeByIdRequest
987
+ */
988
+ export interface PortfolioManagementApiGetCalculatedTradeByIdRequest {
989
+ /**
990
+ * The ID of the PortfolioGroup to perform rebalancing calculations
991
+ * @type {string}
992
+ * @memberof PortfolioManagementApiGetCalculatedTradeById
993
+ */
994
+ readonly portfolioGroupId: string;
995
+ /**
996
+ * The ID of calculated trade to get account impact
997
+ * @type {string}
998
+ * @memberof PortfolioManagementApiGetCalculatedTradeById
999
+ */
1000
+ readonly calculatedTradeId: string;
1001
+ /**
1002
+ * The ID of trade object
1003
+ * @type {string}
1004
+ * @memberof PortfolioManagementApiGetCalculatedTradeById
1005
+ */
1006
+ readonly tradeId: string;
1007
+ }
1008
+ /**
1009
+ * Request parameters for getModelDetailsById operation in PortfolioManagementApi.
1010
+ * @export
1011
+ * @interface PortfolioManagementApiGetModelDetailsByIdRequest
1012
+ */
1013
+ export interface PortfolioManagementApiGetModelDetailsByIdRequest {
1014
+ /**
1015
+ * The ID of the model portfolio to get.
1016
+ * @type {string}
1017
+ * @memberof PortfolioManagementApiGetModelDetailsById
1018
+ */
1019
+ readonly modelPortfolioId: string;
1020
+ }
1021
+ /**
1022
+ * Request parameters for getPortfolioBalances operation in PortfolioManagementApi.
1023
+ * @export
1024
+ * @interface PortfolioManagementApiGetPortfolioBalancesRequest
1025
+ */
1026
+ export interface PortfolioManagementApiGetPortfolioBalancesRequest {
1027
+ /**
1028
+ * The ID of the PortfolioGroup under which to create the target asset.
1029
+ * @type {string}
1030
+ * @memberof PortfolioManagementApiGetPortfolioBalances
1031
+ */
1032
+ readonly portfolioGroupId: string;
1033
+ }
1034
+ /**
1035
+ * Request parameters for getPortfolioDetailsById operation in PortfolioManagementApi.
1036
+ * @export
1037
+ * @interface PortfolioManagementApiGetPortfolioDetailsByIdRequest
1038
+ */
1039
+ export interface PortfolioManagementApiGetPortfolioDetailsByIdRequest {
1040
+ /**
1041
+ * The ID of the PortfolioGroup to get.
1042
+ * @type {string}
1043
+ * @memberof PortfolioManagementApiGetPortfolioDetailsById
1044
+ */
1045
+ readonly portfolioGroupId: string;
1046
+ }
1047
+ /**
1048
+ * Request parameters for getPortfolioInfo operation in PortfolioManagementApi.
1049
+ * @export
1050
+ * @interface PortfolioManagementApiGetPortfolioInfoRequest
1051
+ */
1052
+ export interface PortfolioManagementApiGetPortfolioInfoRequest {
1053
+ /**
1054
+ * The ID of the PortfolioGroup under which to create the target asset.
1055
+ * @type {string}
1056
+ * @memberof PortfolioManagementApiGetPortfolioInfo
1057
+ */
1058
+ readonly portfolioGroupId: string;
1059
+ }
1060
+ /**
1061
+ * Request parameters for getPortfolioPositions operation in PortfolioManagementApi.
1062
+ * @export
1063
+ * @interface PortfolioManagementApiGetPortfolioPositionsRequest
1064
+ */
1065
+ export interface PortfolioManagementApiGetPortfolioPositionsRequest {
1066
+ /**
1067
+ * The ID of the PortfolioGroup under which to create the target asset.
1068
+ * @type {string}
1069
+ * @memberof PortfolioManagementApiGetPortfolioPositions
1070
+ */
1071
+ readonly portfolioGroupId: string;
1072
+ }
1073
+ /**
1074
+ * Request parameters for getPortfolioSettings operation in PortfolioManagementApi.
1075
+ * @export
1076
+ * @interface PortfolioManagementApiGetPortfolioSettingsRequest
1077
+ */
1078
+ export interface PortfolioManagementApiGetPortfolioSettingsRequest {
1079
+ /**
1080
+ * The ID of the PortfolioGroup under which to get the settings.
1081
+ * @type {string}
1082
+ * @memberof PortfolioManagementApiGetPortfolioSettings
1083
+ */
1084
+ readonly portfolioGroupId: string;
1085
+ }
1086
+ /**
1087
+ * Request parameters for getPortfolioTargetById operation in PortfolioManagementApi.
1088
+ * @export
1089
+ * @interface PortfolioManagementApiGetPortfolioTargetByIdRequest
1090
+ */
1091
+ export interface PortfolioManagementApiGetPortfolioTargetByIdRequest {
1092
+ /**
1093
+ * The ID of the PortfolioGroup under which to get the target asset.
1094
+ * @type {string}
1095
+ * @memberof PortfolioManagementApiGetPortfolioTargetById
1096
+ */
1097
+ readonly portfolioGroupId: string;
1098
+ /**
1099
+ * The ID of the TargetAsset to get.
1100
+ * @type {string}
1101
+ * @memberof PortfolioManagementApiGetPortfolioTargetById
1102
+ */
1103
+ readonly targetAssetId: string;
1104
+ }
1105
+ /**
1106
+ * Request parameters for getPortfolioTargets operation in PortfolioManagementApi.
1107
+ * @export
1108
+ * @interface PortfolioManagementApiGetPortfolioTargetsRequest
1109
+ */
1110
+ export interface PortfolioManagementApiGetPortfolioTargetsRequest {
1111
+ /**
1112
+ * The ID of the PortfolioGroup under which to create the target asset.
1113
+ * @type {string}
1114
+ * @memberof PortfolioManagementApiGetPortfolioTargets
1115
+ */
1116
+ readonly portfolioGroupId: string;
1117
+ }
1118
+ /**
1119
+ * Request parameters for getPortoflioExcludedAssets operation in PortfolioManagementApi.
1120
+ * @export
1121
+ * @interface PortfolioManagementApiGetPortoflioExcludedAssetsRequest
1122
+ */
1123
+ export interface PortfolioManagementApiGetPortoflioExcludedAssetsRequest {
1124
+ /**
1125
+ * The ID of the PortfolioGroup under which the excluded assets are linked.
1126
+ * @type {string}
1127
+ * @memberof PortfolioManagementApiGetPortoflioExcludedAssets
1128
+ */
1129
+ readonly portfolioGroupId: string;
1130
+ }
1131
+ /**
1132
+ * Request parameters for importModelPortfolio operation in PortfolioManagementApi.
1133
+ * @export
1134
+ * @interface PortfolioManagementApiImportModelPortfolioRequest
1135
+ */
1136
+ export interface PortfolioManagementApiImportModelPortfolioRequest {
1137
+ /**
1138
+ * The ID of the PortfolioGroup under which to create the target asset.
1139
+ * @type {string}
1140
+ * @memberof PortfolioManagementApiImportModelPortfolio
1141
+ */
1142
+ readonly portfolioGroupId: string;
1143
+ }
1144
+ /**
1145
+ * Request parameters for list operation in PortfolioManagementApi.
1146
+ * @export
1147
+ * @interface PortfolioManagementApiListRequest
1148
+ */
1149
+ export interface PortfolioManagementApiListRequest {
1150
+ /**
1151
+ *
1152
+ * @type {string}
1153
+ * @memberof PortfolioManagementApiList
1154
+ */
1155
+ readonly userId: string;
1156
+ /**
1157
+ *
1158
+ * @type {string}
1159
+ * @memberof PortfolioManagementApiList
1160
+ */
1161
+ readonly userSecret: string;
1162
+ }
1163
+ /**
1164
+ * Request parameters for listCalculatedTrades operation in PortfolioManagementApi.
1165
+ * @export
1166
+ * @interface PortfolioManagementApiListCalculatedTradesRequest
1167
+ */
1168
+ export interface PortfolioManagementApiListCalculatedTradesRequest {
1169
+ /**
1170
+ * The ID of the PortfolioGroup to perform rebalancing calculations
1171
+ * @type {string}
1172
+ * @memberof PortfolioManagementApiListCalculatedTrades
1173
+ */
1174
+ readonly portfolioGroupId: string;
1175
+ }
1176
+ /**
1177
+ * Request parameters for listPortfolioAccounts operation in PortfolioManagementApi.
1178
+ * @export
1179
+ * @interface PortfolioManagementApiListPortfolioAccountsRequest
1180
+ */
1181
+ export interface PortfolioManagementApiListPortfolioAccountsRequest {
1182
+ /**
1183
+ * The ID of the PortfolioGroup under which the accounts are linked.
1184
+ * @type {string}
1185
+ * @memberof PortfolioManagementApiListPortfolioAccounts
1186
+ */
1187
+ readonly portfolioGroupId: string;
1188
+ }
1189
+ /**
1190
+ * Request parameters for modifyModelPortfolioById operation in PortfolioManagementApi.
1191
+ * @export
1192
+ * @interface PortfolioManagementApiModifyModelPortfolioByIdRequest
1193
+ */
1194
+ export interface PortfolioManagementApiModifyModelPortfolioByIdRequest {
1195
+ /**
1196
+ * The ID of the model portfolio to update.
1197
+ * @type {string}
1198
+ * @memberof PortfolioManagementApiModifyModelPortfolioById
1199
+ */
1200
+ readonly modelPortfolioId: string;
1201
+ /**
1202
+ * Use this endpoint change model asset class name and to add or remove a model portfolio security/model portfolio asset class. <br /><br /> * The model portfolio name and model portfolio model type is required. <br /> * The model portfolio model type must be either 0 or 1. [0 -> Securities based, 1 -> Asset Class based] <br /><br /> * If the model portfolio type is 0, the model portfolio asset class must be an empty array. <br /> * If the model portfolio type is 1, the model portfolio security must be an empty array. <br /><br /> * When updating the model portfolio security, the percent is required. Only the symbol id is required for the symbol object <br /> * When updating the model portfolio asset classes, the percent is required. Only the model asset class id is required for the model asset class object <br /><br /> * To remove all model portfolio securities or model portfolio asset class, set then to an empty array
1203
+ * @type {ModelPortfolioDetails}
1204
+ * @memberof PortfolioManagementApiModifyModelPortfolioById
1205
+ */
1206
+ readonly requestBody: ModelPortfolioDetails;
1207
+ }
1208
+ /**
1209
+ * Request parameters for savePortfolio operation in PortfolioManagementApi.
1210
+ * @export
1211
+ * @interface PortfolioManagementApiSavePortfolioRequest
1212
+ */
1213
+ export interface PortfolioManagementApiSavePortfolioRequest {
1214
+ /**
1215
+ * The ID of the PortfolioGroup to update.
1216
+ * @type {string}
1217
+ * @memberof PortfolioManagementApiSavePortfolio
1218
+ */
1219
+ readonly portfolioGroupId: string;
1220
+ /**
1221
+ *
1222
+ * @type {{ [key: string]: any; }}
1223
+ * @memberof PortfolioManagementApiSavePortfolio
1224
+ */
1225
+ readonly requestBody: {
1226
+ [key: string]: any;
1227
+ };
1228
+ }
1229
+ /**
1230
+ * Request parameters for searchPortfolioSymbols operation in PortfolioManagementApi.
1231
+ * @export
1232
+ * @interface PortfolioManagementApiSearchPortfolioSymbolsRequest
1233
+ */
1234
+ export interface PortfolioManagementApiSearchPortfolioSymbolsRequest {
1235
+ /**
1236
+ * The ID of the PortfolioGroup to search under
1237
+ * @type {string}
1238
+ * @memberof PortfolioManagementApiSearchPortfolioSymbols
1239
+ */
1240
+ readonly portfolioGroupId: string;
1241
+ /**
1242
+ *
1243
+ * @type {SymbolQuery}
1244
+ * @memberof PortfolioManagementApiSearchPortfolioSymbols
1245
+ */
1246
+ readonly requestBody?: SymbolQuery;
1247
+ }
1248
+ /**
1249
+ * Request parameters for setPortfolioTargets operation in PortfolioManagementApi.
1250
+ * @export
1251
+ * @interface PortfolioManagementApiSetPortfolioTargetsRequest
1252
+ */
1253
+ export interface PortfolioManagementApiSetPortfolioTargetsRequest {
1254
+ /**
1255
+ * The ID of the PortfolioGroup under which to create the target asset.
1256
+ * @type {string}
1257
+ * @memberof PortfolioManagementApiSetPortfolioTargets
1258
+ */
1259
+ readonly portfolioGroupId: string;
1260
+ /**
1261
+ *
1262
+ * @type {Array<TargetAsset>}
1263
+ * @memberof PortfolioManagementApiSetPortfolioTargets
1264
+ */
1265
+ readonly requestBody?: Array<TargetAsset>;
1266
+ }
1267
+ /**
1268
+ * Request parameters for updateAssetClass operation in PortfolioManagementApi.
1269
+ * @export
1270
+ * @interface PortfolioManagementApiUpdateAssetClassRequest
1271
+ */
1272
+ export interface PortfolioManagementApiUpdateAssetClassRequest {
1273
+ /**
1274
+ * The ID of the model asset class to update.
1275
+ * @type {string}
1276
+ * @memberof PortfolioManagementApiUpdateAssetClass
1277
+ */
1278
+ readonly modelAssetClassId: string;
1279
+ /**
1280
+ * Use this endpoint change model asset class name and to add or remove a model asset class target. <br /><br /> * Only the model asset class name is required for the model asset class object. <br /> * Only the symbol id is required for the symbol object in the model asset class target object. <br /> * To remove all model asset class targets, set the model asset class target as an empty array
1281
+ * @type {ModelAssetClassDetails}
1282
+ * @memberof PortfolioManagementApiUpdateAssetClass
1283
+ */
1284
+ readonly requestBody: ModelAssetClassDetails;
1285
+ }
1286
+ /**
1287
+ * Request parameters for updatePortfolioSettings operation in PortfolioManagementApi.
1288
+ * @export
1289
+ * @interface PortfolioManagementApiUpdatePortfolioSettingsRequest
1290
+ */
1291
+ export interface PortfolioManagementApiUpdatePortfolioSettingsRequest {
1292
+ /**
1293
+ * The ID of the PortfolioGroup under which to patch the settings.
1294
+ * @type {string}
1295
+ * @memberof PortfolioManagementApiUpdatePortfolioSettings
1296
+ */
1297
+ readonly portfolioGroupId: string;
1298
+ }
1299
+ /**
1300
+ * Request parameters for updatePortfolioTargetById operation in PortfolioManagementApi.
1301
+ * @export
1302
+ * @interface PortfolioManagementApiUpdatePortfolioTargetByIdRequest
1303
+ */
1304
+ export interface PortfolioManagementApiUpdatePortfolioTargetByIdRequest {
1305
+ /**
1306
+ * The ID of the PortfolioGroup under which to patch the target asset.
1307
+ * @type {string}
1308
+ * @memberof PortfolioManagementApiUpdatePortfolioTargetById
1309
+ */
1310
+ readonly portfolioGroupId: string;
1311
+ /**
1312
+ * The ID of the TargetAsset to patch.
1313
+ * @type {string}
1314
+ * @memberof PortfolioManagementApiUpdatePortfolioTargetById
1315
+ */
1316
+ readonly targetAssetId: string;
1317
+ /**
1318
+ *
1319
+ * @type {TargetAsset}
1320
+ * @memberof PortfolioManagementApiUpdatePortfolioTargetById
1321
+ */
1322
+ readonly requestBody: TargetAsset;
1323
+ }
1324
+ /**
1325
+ * PortfolioManagementApi - object-oriented interface
1326
+ * @export
1327
+ * @class PortfolioManagementApi
1328
+ * @extends {BaseAPI}
1329
+ */
1330
+ export declare class PortfolioManagementApi extends BaseAPI {
1331
+ /**
1332
+ *
1333
+ * @summary Adds an asset to exclude to a portfolio group
1334
+ * @param {PortfolioManagementApiAddPortfolioExcludedAssetRequest} requestParameters Request parameters.
1335
+ * @param {*} [options] Override http request option.
1336
+ * @throws {RequiredError}
1337
+ * @memberof PortfolioManagementApi
1338
+ */
1339
+ addPortfolioExcludedAsset(requestParameters: PortfolioManagementApiAddPortfolioExcludedAssetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExcludedAsset, any>>;
1340
+ /**
1341
+ *
1342
+ * @summary Create new portfolio group
1343
+ * @param {PortfolioManagementApiCreateRequest} requestParameters Request parameters.
1344
+ * @param {*} [options] Override http request option.
1345
+ * @throws {RequiredError}
1346
+ * @memberof PortfolioManagementApi
1347
+ */
1348
+ create(requestParameters: PortfolioManagementApiCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroup[], any>>;
1349
+ /**
1350
+ *
1351
+ * @summary Create a new model asset class
1352
+ * @param {*} [options] Override http request option.
1353
+ * @throws {RequiredError}
1354
+ * @memberof PortfolioManagementApi
1355
+ */
1356
+ createAssetClass(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelAssetClassDetails, any>>;
1357
+ /**
1358
+ *
1359
+ * @summary Creates a new model portfolio
1360
+ * @param {*} [options] Override http request option.
1361
+ * @throws {RequiredError}
1362
+ * @memberof PortfolioManagementApi
1363
+ */
1364
+ createModelPortfolio(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelPortfolioDetails, any>>;
1365
+ /**
1366
+ *
1367
+ * @summary Deletes a model asset class
1368
+ * @param {PortfolioManagementApiDeleteAssetClassRequest} requestParameters Request parameters.
1369
+ * @param {*} [options] Override http request option.
1370
+ * @throws {RequiredError}
1371
+ * @memberof PortfolioManagementApi
1372
+ */
1373
+ deleteAssetClass(requestParameters: PortfolioManagementApiDeleteAssetClassRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1374
+ /**
1375
+ *
1376
+ * @summary Unexclude an asset from a portfolio group
1377
+ * @param {PortfolioManagementApiDeleteExcludedAssetRequest} requestParameters Request parameters.
1378
+ * @param {*} [options] Override http request option.
1379
+ * @throws {RequiredError}
1380
+ * @memberof PortfolioManagementApi
1381
+ */
1382
+ deleteExcludedAsset(requestParameters: PortfolioManagementApiDeleteExcludedAssetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1383
+ /**
1384
+ *
1385
+ * @summary Deletes a model portfolio
1386
+ * @param {PortfolioManagementApiDeleteModelPortfolioByIdRequest} requestParameters Request parameters.
1387
+ * @param {*} [options] Override http request option.
1388
+ * @throws {RequiredError}
1389
+ * @memberof PortfolioManagementApi
1390
+ */
1391
+ deleteModelPortfolioById(requestParameters: PortfolioManagementApiDeleteModelPortfolioByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1392
+ /**
1393
+ *
1394
+ * @summary Remove a target portfolio.
1395
+ * @param {PortfolioManagementApiDeletePortfoliRequest} requestParameters Request parameters.
1396
+ * @param {*} [options] Override http request option.
1397
+ * @throws {RequiredError}
1398
+ * @memberof PortfolioManagementApi
1399
+ */
1400
+ deletePortfoli(requestParameters: PortfolioManagementApiDeletePortfoliRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroup, any>>;
1401
+ /**
1402
+ *
1403
+ * @summary Remove a TargetAsset.
1404
+ * @param {PortfolioManagementApiDeletePortfolioTargetByIdRequest} requestParameters Request parameters.
1405
+ * @param {*} [options] Override http request option.
1406
+ * @throws {RequiredError}
1407
+ * @memberof PortfolioManagementApi
1408
+ */
1409
+ deletePortfolioTargetById(requestParameters: PortfolioManagementApiDeletePortfolioTargetByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TargetAsset, any>>;
1410
+ /**
1411
+ *
1412
+ * @summary Get details of a model asset class
1413
+ * @param {PortfolioManagementApiDetailAssetClassRequest} requestParameters Request parameters.
1414
+ * @param {*} [options] Override http request option.
1415
+ * @throws {RequiredError}
1416
+ * @memberof PortfolioManagementApi
1417
+ */
1418
+ detailAssetClass(requestParameters: PortfolioManagementApiDetailAssetClassRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelAssetClassDetails, any>>;
1419
+ /**
1420
+ *
1421
+ * @summary Return an individual trade
1422
+ * @param {PortfolioManagementApiGetCalculatedTradeByIdRequest} requestParameters Request parameters.
1423
+ * @param {*} [options] Override http request option.
1424
+ * @throws {RequiredError}
1425
+ * @memberof PortfolioManagementApi
1426
+ */
1427
+ getCalculatedTradeById(requestParameters: PortfolioManagementApiGetCalculatedTradeByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Trade[], any>>;
1428
+ /**
1429
+ *
1430
+ * @summary Get details of a model portfolio
1431
+ * @param {PortfolioManagementApiGetModelDetailsByIdRequest} requestParameters Request parameters.
1432
+ * @param {*} [options] Override http request option.
1433
+ * @throws {RequiredError}
1434
+ * @memberof PortfolioManagementApi
1435
+ */
1436
+ getModelDetailsById(requestParameters: PortfolioManagementApiGetModelDetailsByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelPortfolioDetails, any>>;
1437
+ /**
1438
+ *
1439
+ * @summary Get sum of cash balances in portfolio group
1440
+ * @param {PortfolioManagementApiGetPortfolioBalancesRequest} requestParameters Request parameters.
1441
+ * @param {*} [options] Override http request option.
1442
+ * @throws {RequiredError}
1443
+ * @memberof PortfolioManagementApi
1444
+ */
1445
+ getPortfolioBalances(requestParameters: PortfolioManagementApiGetPortfolioBalancesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance[], any>>;
1446
+ /**
1447
+ *
1448
+ * @summary Get details of a target portfolio
1449
+ * @param {PortfolioManagementApiGetPortfolioDetailsByIdRequest} requestParameters Request parameters.
1450
+ * @param {*} [options] Override http request option.
1451
+ * @throws {RequiredError}
1452
+ * @memberof PortfolioManagementApi
1453
+ */
1454
+ getPortfolioDetailsById(requestParameters: PortfolioManagementApiGetPortfolioDetailsByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroup, any>>;
1455
+ /**
1456
+ *
1457
+ * @summary Return a whole bunch of relevant information relating to a portfolio group.
1458
+ * @param {PortfolioManagementApiGetPortfolioInfoRequest} requestParameters Request parameters.
1459
+ * @param {*} [options] Override http request option.
1460
+ * @throws {RequiredError}
1461
+ * @memberof PortfolioManagementApi
1462
+ */
1463
+ getPortfolioInfo(requestParameters: PortfolioManagementApiGetPortfolioInfoRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroupInfo, any>>;
1464
+ /**
1465
+ *
1466
+ * @summary Get total of each postions owned in portfolio group
1467
+ * @param {PortfolioManagementApiGetPortfolioPositionsRequest} requestParameters Request parameters.
1468
+ * @param {*} [options] Override http request option.
1469
+ * @throws {RequiredError}
1470
+ * @memberof PortfolioManagementApi
1471
+ */
1472
+ getPortfolioPositions(requestParameters: PortfolioManagementApiGetPortfolioPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroupPosition[], any>>;
1473
+ /**
1474
+ *
1475
+ * @summary Get portfolio group settings
1476
+ * @param {PortfolioManagementApiGetPortfolioSettingsRequest} requestParameters Request parameters.
1477
+ * @param {*} [options] Override http request option.
1478
+ * @throws {RequiredError}
1479
+ * @memberof PortfolioManagementApi
1480
+ */
1481
+ getPortfolioSettings(requestParameters: PortfolioManagementApiGetPortfolioSettingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroupSettings, any>>;
1482
+ /**
1483
+ *
1484
+ * @summary Get a specific target from a portfolio group
1485
+ * @param {PortfolioManagementApiGetPortfolioTargetByIdRequest} requestParameters Request parameters.
1486
+ * @param {*} [options] Override http request option.
1487
+ * @throws {RequiredError}
1488
+ * @memberof PortfolioManagementApi
1489
+ */
1490
+ getPortfolioTargetById(requestParameters: PortfolioManagementApiGetPortfolioTargetByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TargetAsset, any>>;
1491
+ /**
1492
+ *
1493
+ * @summary Get all target assets under the specified PortfolioGroup.
1494
+ * @param {PortfolioManagementApiGetPortfolioTargetsRequest} requestParameters Request parameters.
1495
+ * @param {*} [options] Override http request option.
1496
+ * @throws {RequiredError}
1497
+ * @memberof PortfolioManagementApi
1498
+ */
1499
+ getPortfolioTargets(requestParameters: PortfolioManagementApiGetPortfolioTargetsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TargetAsset[], any>>;
1500
+ /**
1501
+ *
1502
+ * @summary Get an array of excluded assets associated with a portfolio group\\
1503
+ * @param {PortfolioManagementApiGetPortoflioExcludedAssetsRequest} requestParameters Request parameters.
1504
+ * @param {*} [options] Override http request option.
1505
+ * @throws {RequiredError}
1506
+ * @memberof PortfolioManagementApi
1507
+ */
1508
+ getPortoflioExcludedAssets(requestParameters: PortfolioManagementApiGetPortoflioExcludedAssetsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExcludedAsset[], any>>;
1509
+ /**
1510
+ *
1511
+ * @summary Import target allocation based on portfolio group
1512
+ * @param {PortfolioManagementApiImportModelPortfolioRequest} requestParameters Request parameters.
1513
+ * @param {*} [options] Override http request option.
1514
+ * @throws {RequiredError}
1515
+ * @memberof PortfolioManagementApi
1516
+ */
1517
+ importModelPortfolio(requestParameters: PortfolioManagementApiImportModelPortfolioRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TargetAsset[], any>>;
1518
+ /**
1519
+ *
1520
+ * @summary List all portfolio groups
1521
+ * @param {PortfolioManagementApiListRequest} requestParameters Request parameters.
1522
+ * @param {*} [options] Override http request option.
1523
+ * @throws {RequiredError}
1524
+ * @memberof PortfolioManagementApi
1525
+ */
1526
+ list(requestParameters: PortfolioManagementApiListRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroup[], any>>;
1527
+ /**
1528
+ *
1529
+ * @summary List of model asset class
1530
+ * @param {*} [options] Override http request option.
1531
+ * @throws {RequiredError}
1532
+ * @memberof PortfolioManagementApi
1533
+ */
1534
+ listAssetClasses(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelAssetClassDetails[], any>>;
1535
+ /**
1536
+ *
1537
+ * @summary List of trades to make to rebalance portfolio group
1538
+ * @param {PortfolioManagementApiListCalculatedTradesRequest} requestParameters Request parameters.
1539
+ * @param {*} [options] Override http request option.
1540
+ * @throws {RequiredError}
1541
+ * @memberof PortfolioManagementApi
1542
+ */
1543
+ listCalculatedTrades(requestParameters: PortfolioManagementApiListCalculatedTradesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CalculatedTrade, any>>;
1544
+ /**
1545
+ *
1546
+ * @summary List of model portfolio
1547
+ * @param {*} [options] Override http request option.
1548
+ * @throws {RequiredError}
1549
+ * @memberof PortfolioManagementApi
1550
+ */
1551
+ listModelPortfolio(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelPortfolioDetails[], any>>;
1552
+ /**
1553
+ *
1554
+ * @summary Get all accounts associated with a portfolio group
1555
+ * @param {PortfolioManagementApiListPortfolioAccountsRequest} requestParameters Request parameters.
1556
+ * @param {*} [options] Override http request option.
1557
+ * @throws {RequiredError}
1558
+ * @memberof PortfolioManagementApi
1559
+ */
1560
+ listPortfolioAccounts(requestParameters: PortfolioManagementApiListPortfolioAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any>>;
1561
+ /**
1562
+ *
1563
+ * @summary Updates model portfolio object
1564
+ * @param {PortfolioManagementApiModifyModelPortfolioByIdRequest} requestParameters Request parameters.
1565
+ * @param {*} [options] Override http request option.
1566
+ * @throws {RequiredError}
1567
+ * @memberof PortfolioManagementApi
1568
+ */
1569
+ modifyModelPortfolioById(requestParameters: PortfolioManagementApiModifyModelPortfolioByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1570
+ /**
1571
+ *
1572
+ * @summary Update an existing target portfolio.
1573
+ * @param {PortfolioManagementApiSavePortfolioRequest} requestParameters Request parameters.
1574
+ * @param {*} [options] Override http request option.
1575
+ * @throws {RequiredError}
1576
+ * @memberof PortfolioManagementApi
1577
+ */
1578
+ savePortfolio(requestParameters: PortfolioManagementApiSavePortfolioRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroup, any>>;
1579
+ /**
1580
+ *
1581
+ * @summary Search for symbols limited to brokerages under the specified portfolio group
1582
+ * @param {PortfolioManagementApiSearchPortfolioSymbolsRequest} requestParameters Request parameters.
1583
+ * @param {*} [options] Override http request option.
1584
+ * @throws {RequiredError}
1585
+ * @memberof PortfolioManagementApi
1586
+ */
1587
+ searchPortfolioSymbols(requestParameters: PortfolioManagementApiSearchPortfolioSymbolsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
1588
+ /**
1589
+ *
1590
+ * @summary Set a new list of target assets under the specified PortfolioGroup. All existing target assets under this portfolio group will be replaced with the new list.
1591
+ * @param {PortfolioManagementApiSetPortfolioTargetsRequest} requestParameters Request parameters.
1592
+ * @param {*} [options] Override http request option.
1593
+ * @throws {RequiredError}
1594
+ * @memberof PortfolioManagementApi
1595
+ */
1596
+ setPortfolioTargets(requestParameters: PortfolioManagementApiSetPortfolioTargetsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TargetAsset[], any>>;
1597
+ /**
1598
+ *
1599
+ * @summary Updates model asset class objects
1600
+ * @param {PortfolioManagementApiUpdateAssetClassRequest} requestParameters Request parameters.
1601
+ * @param {*} [options] Override http request option.
1602
+ * @throws {RequiredError}
1603
+ * @memberof PortfolioManagementApi
1604
+ */
1605
+ updateAssetClass(requestParameters: PortfolioManagementApiUpdateAssetClassRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1606
+ /**
1607
+ *
1608
+ * @summary Updates portfolio group settings
1609
+ * @param {PortfolioManagementApiUpdatePortfolioSettingsRequest} requestParameters Request parameters.
1610
+ * @param {*} [options] Override http request option.
1611
+ * @throws {RequiredError}
1612
+ * @memberof PortfolioManagementApi
1613
+ */
1614
+ updatePortfolioSettings(requestParameters: PortfolioManagementApiUpdatePortfolioSettingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroupSettings, any>>;
1615
+ /**
1616
+ *
1617
+ * @summary Update a TargetAsset under the specified PortfolioGroup.
1618
+ * @param {PortfolioManagementApiUpdatePortfolioTargetByIdRequest} requestParameters Request parameters.
1619
+ * @param {*} [options] Override http request option.
1620
+ * @throws {RequiredError}
1621
+ * @memberof PortfolioManagementApi
1622
+ */
1623
+ updatePortfolioTargetById(requestParameters: PortfolioManagementApiUpdatePortfolioTargetByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TargetAsset, any>>;
1624
+ }