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,591 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * SnapTrade
5
+ * Connect brokerage accounts to your app for live positions and trading
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: api@snaptrade.com
9
+ *
10
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
11
+ * https://konfigthis.com
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
16
+ import { Configuration } from '../configuration';
17
+ // Some imports not used depending on template conditions
18
+ // @ts-ignore
19
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
20
+ // @ts-ignore
21
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
22
+ // @ts-ignore
23
+ import { AuthenticationLoginSnapTradeUser200Response } from '../models';
24
+ // @ts-ignore
25
+ import { DeleteUserResponse } from '../models';
26
+ // @ts-ignore
27
+ import { EncryptedResponse } from '../models';
28
+ // @ts-ignore
29
+ import { Model400FailedRequestResponse } from '../models';
30
+ // @ts-ignore
31
+ import { Model403FailedRequestResponse } from '../models';
32
+ // @ts-ignore
33
+ import { Model404FailedRequestResponse } from '../models';
34
+ // @ts-ignore
35
+ import { SnapTradeLoginUserRequestBody } from '../models';
36
+ // @ts-ignore
37
+ import { SnapTradeRegisterUserRequestBody } from '../models';
38
+ // @ts-ignore
39
+ import { UserIDandSecret } from '../models';
40
+ import { paginate } from "../pagination/paginate";
41
+ import { requestBeforeHook } from '../requestBeforeHook';
42
+ /**
43
+ * AuthenticationApi - axios parameter creator
44
+ * @export
45
+ */
46
+ export const AuthenticationApiAxiosParamCreator = function (configuration?: Configuration) {
47
+ return {
48
+ /**
49
+ *
50
+ * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
51
+ * @param {string} userId
52
+ * @param {*} [options] Override http request option.
53
+ * @throws {RequiredError}
54
+ */
55
+ deleteSnapTradeUser: async (userId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
56
+ // verify required parameter 'userId' is not null or undefined
57
+ assertParamExists('deleteSnapTradeUser', 'userId', userId)
58
+ const localVarPath = `/snapTrade/deleteUser`;
59
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
60
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
61
+ let baseOptions;
62
+ if (configuration) {
63
+ baseOptions = configuration.baseOptions;
64
+ }
65
+
66
+ const localVarRequestOptions: AxiosRequestConfig = { method: 'DELETE', ...baseOptions, ...options};
67
+ const localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {} as any;
68
+ const localVarQueryParameter = {} as any;
69
+
70
+ // authentication PartnerClientId required
71
+ await setApiKeyToObject(localVarQueryParameter, "clientId", configuration)
72
+
73
+ // authentication PartnerSignature required
74
+ await setApiKeyToObject(localVarHeaderParameter, "Signature", configuration)
75
+
76
+ // authentication PartnerTimestamp required
77
+ await setApiKeyToObject(localVarQueryParameter, "timestamp", configuration)
78
+
79
+ if (userId !== undefined) {
80
+ localVarQueryParameter['userId'] = userId;
81
+ }
82
+
83
+
84
+
85
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
86
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
87
+
88
+ requestBeforeHook({
89
+ queryParameters: localVarQueryParameter,
90
+ requestConfig: localVarRequestOptions,
91
+ path: localVarPath,
92
+ configuration
93
+ });
94
+
95
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
96
+ return {
97
+ url: toPathString(localVarUrlObj),
98
+ options: localVarRequestOptions,
99
+ };
100
+ },
101
+ /**
102
+ *
103
+ * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
104
+ * @param {string} userId
105
+ * @param {string} userSecret
106
+ * @param {*} [options] Override http request option.
107
+ * @throws {RequiredError}
108
+ */
109
+ getUserJWT: async (userId: string, userSecret: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
110
+ // verify required parameter 'userId' is not null or undefined
111
+ assertParamExists('getUserJWT', 'userId', userId)
112
+ // verify required parameter 'userSecret' is not null or undefined
113
+ assertParamExists('getUserJWT', 'userSecret', userSecret)
114
+ const localVarPath = `/snapTrade/encryptedJWT`;
115
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
116
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
117
+ let baseOptions;
118
+ if (configuration) {
119
+ baseOptions = configuration.baseOptions;
120
+ }
121
+
122
+ const localVarRequestOptions: AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
123
+ const localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {} as any;
124
+ const localVarQueryParameter = {} as any;
125
+
126
+ // authentication PartnerClientId required
127
+ await setApiKeyToObject(localVarQueryParameter, "clientId", configuration)
128
+
129
+ // authentication PartnerSignature required
130
+ await setApiKeyToObject(localVarHeaderParameter, "Signature", configuration)
131
+
132
+ // authentication PartnerTimestamp required
133
+ await setApiKeyToObject(localVarQueryParameter, "timestamp", configuration)
134
+
135
+ if (userId !== undefined) {
136
+ localVarQueryParameter['userId'] = userId;
137
+ }
138
+
139
+ if (userSecret !== undefined) {
140
+ localVarQueryParameter['userSecret'] = userSecret;
141
+ }
142
+
143
+
144
+
145
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
146
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
147
+
148
+ requestBeforeHook({
149
+ queryParameters: localVarQueryParameter,
150
+ requestConfig: localVarRequestOptions,
151
+ path: localVarPath,
152
+ configuration
153
+ });
154
+
155
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
156
+ return {
157
+ url: toPathString(localVarUrlObj),
158
+ options: localVarRequestOptions,
159
+ };
160
+ },
161
+ /**
162
+ *
163
+ * @summary Get a list of all SnapTrade users you\'ve registered on our platform
164
+ * @param {*} [options] Override http request option.
165
+ * @throws {RequiredError}
166
+ */
167
+ listSnapTradeUsers: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
168
+ const localVarPath = `/snapTrade/listUsers`;
169
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
170
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
171
+ let baseOptions;
172
+ if (configuration) {
173
+ baseOptions = configuration.baseOptions;
174
+ }
175
+
176
+ const localVarRequestOptions: AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
177
+ const localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {} as any;
178
+ const localVarQueryParameter = {} as any;
179
+
180
+ // authentication PartnerClientId required
181
+ await setApiKeyToObject(localVarQueryParameter, "clientId", configuration)
182
+
183
+ // authentication PartnerSignature required
184
+ await setApiKeyToObject(localVarHeaderParameter, "Signature", configuration)
185
+
186
+ // authentication PartnerTimestamp required
187
+ await setApiKeyToObject(localVarQueryParameter, "timestamp", configuration)
188
+
189
+
190
+
191
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
192
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
193
+
194
+ requestBeforeHook({
195
+ queryParameters: localVarQueryParameter,
196
+ requestConfig: localVarRequestOptions,
197
+ path: localVarPath,
198
+ configuration
199
+ });
200
+
201
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
202
+ return {
203
+ url: toPathString(localVarUrlObj),
204
+ options: localVarRequestOptions,
205
+ };
206
+ },
207
+ /**
208
+ *
209
+ * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
210
+ * @param {string} userId
211
+ * @param {string} userSecret
212
+ * @param {SnapTradeLoginUserRequestBody} [snapTradeLoginUserRequestBody]
213
+ * @param {*} [options] Override http request option.
214
+ * @throws {RequiredError}
215
+ */
216
+ loginSnapTradeUser: async (userId: string, userSecret: string, snapTradeLoginUserRequestBody?: SnapTradeLoginUserRequestBody, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
217
+ // verify required parameter 'userId' is not null or undefined
218
+ assertParamExists('loginSnapTradeUser', 'userId', userId)
219
+ // verify required parameter 'userSecret' is not null or undefined
220
+ assertParamExists('loginSnapTradeUser', 'userSecret', userSecret)
221
+ const localVarPath = `/snapTrade/login`;
222
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
223
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
224
+ let baseOptions;
225
+ if (configuration) {
226
+ baseOptions = configuration.baseOptions;
227
+ }
228
+
229
+ const localVarRequestOptions: AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
230
+ const localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {} as any;
231
+ const localVarQueryParameter = {} as any;
232
+
233
+ // authentication PartnerClientId required
234
+ await setApiKeyToObject(localVarQueryParameter, "clientId", configuration)
235
+
236
+ // authentication PartnerSignature required
237
+ await setApiKeyToObject(localVarHeaderParameter, "Signature", configuration)
238
+
239
+ // authentication PartnerTimestamp required
240
+ await setApiKeyToObject(localVarQueryParameter, "timestamp", configuration)
241
+
242
+ if (userId !== undefined) {
243
+ localVarQueryParameter['userId'] = userId;
244
+ }
245
+
246
+ if (userSecret !== undefined) {
247
+ localVarQueryParameter['userSecret'] = userSecret;
248
+ }
249
+
250
+
251
+
252
+ localVarHeaderParameter['Content-Type'] = 'application/json';
253
+
254
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
255
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
256
+ localVarRequestOptions.data = serializeDataIfNeeded(snapTradeLoginUserRequestBody, localVarRequestOptions, configuration)
257
+
258
+ requestBeforeHook({
259
+ queryParameters: localVarQueryParameter,
260
+ requestConfig: localVarRequestOptions,
261
+ path: localVarPath,
262
+ configuration
263
+ });
264
+
265
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
266
+ return {
267
+ url: toPathString(localVarUrlObj),
268
+ options: localVarRequestOptions,
269
+ };
270
+ },
271
+ /**
272
+ *
273
+ * @summary Register user with SnapTrade in order to create secure brokerage authorizations
274
+ * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
275
+ * @param {*} [options] Override http request option.
276
+ * @throws {RequiredError}
277
+ */
278
+ registerSnapTradeUser: async (snapTradeRegisterUserRequestBody: SnapTradeRegisterUserRequestBody, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
279
+ // verify required parameter 'snapTradeRegisterUserRequestBody' is not null or undefined
280
+ assertParamExists('registerSnapTradeUser', 'snapTradeRegisterUserRequestBody', snapTradeRegisterUserRequestBody)
281
+ const localVarPath = `/snapTrade/registerUser`;
282
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
283
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
284
+ let baseOptions;
285
+ if (configuration) {
286
+ baseOptions = configuration.baseOptions;
287
+ }
288
+
289
+ const localVarRequestOptions: AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
290
+ const localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {} as any;
291
+ const localVarQueryParameter = {} as any;
292
+
293
+ // authentication PartnerClientId required
294
+ await setApiKeyToObject(localVarQueryParameter, "clientId", configuration)
295
+
296
+ // authentication PartnerSignature required
297
+ await setApiKeyToObject(localVarHeaderParameter, "Signature", configuration)
298
+
299
+ // authentication PartnerTimestamp required
300
+ await setApiKeyToObject(localVarQueryParameter, "timestamp", configuration)
301
+
302
+
303
+
304
+ localVarHeaderParameter['Content-Type'] = 'application/json';
305
+
306
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
307
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
308
+ localVarRequestOptions.data = serializeDataIfNeeded(snapTradeRegisterUserRequestBody, localVarRequestOptions, configuration)
309
+
310
+ requestBeforeHook({
311
+ queryParameters: localVarQueryParameter,
312
+ requestConfig: localVarRequestOptions,
313
+ path: localVarPath,
314
+ configuration
315
+ });
316
+
317
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
318
+ return {
319
+ url: toPathString(localVarUrlObj),
320
+ options: localVarRequestOptions,
321
+ };
322
+ },
323
+ }
324
+ };
325
+
326
+ /**
327
+ * AuthenticationApi - functional programming interface
328
+ * @export
329
+ */
330
+ export const AuthenticationApiFp = function(configuration?: Configuration) {
331
+ const localVarAxiosParamCreator = AuthenticationApiAxiosParamCreator(configuration)
332
+ return {
333
+ /**
334
+ *
335
+ * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
336
+ * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
337
+ * @param {*} [options] Override http request option.
338
+ * @throws {RequiredError}
339
+ */
340
+ async deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUserResponse>> {
341
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSnapTradeUser(requestParameters.userId, options);
342
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
343
+ },
344
+ /**
345
+ *
346
+ * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
347
+ * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
348
+ * @param {*} [options] Override http request option.
349
+ * @throws {RequiredError}
350
+ */
351
+ async getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EncryptedResponse>> {
352
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getUserJWT(requestParameters.userId, requestParameters.userSecret, options);
353
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
354
+ },
355
+ /**
356
+ *
357
+ * @summary Get a list of all SnapTrade users you\'ve registered on our platform
358
+ * @param {*} [options] Override http request option.
359
+ * @throws {RequiredError}
360
+ */
361
+ async listSnapTradeUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
362
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSnapTradeUsers(options);
363
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
364
+ },
365
+ /**
366
+ *
367
+ * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
368
+ * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
369
+ * @param {*} [options] Override http request option.
370
+ * @throws {RequiredError}
371
+ */
372
+ async loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationLoginSnapTradeUser200Response>> {
373
+ const localVarAxiosArgs = await localVarAxiosParamCreator.loginSnapTradeUser(requestParameters.userId, requestParameters.userSecret, requestParameters.requestBody, options);
374
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
375
+ },
376
+ /**
377
+ *
378
+ * @summary Register user with SnapTrade in order to create secure brokerage authorizations
379
+ * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
380
+ * @param {*} [options] Override http request option.
381
+ * @throws {RequiredError}
382
+ */
383
+ async registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserIDandSecret>> {
384
+ const localVarAxiosArgs = await localVarAxiosParamCreator.registerSnapTradeUser(requestParameters.requestBody, options);
385
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
386
+ },
387
+ }
388
+ };
389
+
390
+ /**
391
+ * AuthenticationApi - factory interface
392
+ * @export
393
+ */
394
+ export const AuthenticationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
395
+ const localVarFp = AuthenticationApiFp(configuration)
396
+ return {
397
+ /**
398
+ *
399
+ * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
400
+ * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
401
+ * @param {*} [options] Override http request option.
402
+ * @throws {RequiredError}
403
+ */
404
+ deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteUserResponse> {
405
+ return localVarFp.deleteSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
406
+ },
407
+ /**
408
+ *
409
+ * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
410
+ * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
411
+ * @param {*} [options] Override http request option.
412
+ * @throws {RequiredError}
413
+ */
414
+ getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): AxiosPromise<EncryptedResponse> {
415
+ return localVarFp.getUserJWT(requestParameters, options).then((request) => request(axios, basePath));
416
+ },
417
+ /**
418
+ *
419
+ * @summary Get a list of all SnapTrade users you\'ve registered on our platform
420
+ * @param {*} [options] Override http request option.
421
+ * @throws {RequiredError}
422
+ */
423
+ listSnapTradeUsers(options?: AxiosRequestConfig): AxiosPromise<Array<string>> {
424
+ return localVarFp.listSnapTradeUsers(options).then((request) => request(axios, basePath));
425
+ },
426
+ /**
427
+ *
428
+ * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
429
+ * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
430
+ * @param {*} [options] Override http request option.
431
+ * @throws {RequiredError}
432
+ */
433
+ loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<AuthenticationLoginSnapTradeUser200Response> {
434
+ return localVarFp.loginSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
435
+ },
436
+ /**
437
+ *
438
+ * @summary Register user with SnapTrade in order to create secure brokerage authorizations
439
+ * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
440
+ * @param {*} [options] Override http request option.
441
+ * @throws {RequiredError}
442
+ */
443
+ registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<UserIDandSecret> {
444
+ return localVarFp.registerSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
445
+ },
446
+ };
447
+ };
448
+
449
+ /**
450
+ * Request parameters for deleteSnapTradeUser operation in AuthenticationApi.
451
+ * @export
452
+ * @interface AuthenticationApiDeleteSnapTradeUserRequest
453
+ */
454
+ export interface AuthenticationApiDeleteSnapTradeUserRequest {
455
+ /**
456
+ *
457
+ * @type {string}
458
+ * @memberof AuthenticationApiDeleteSnapTradeUser
459
+ */
460
+ readonly userId: string
461
+ }
462
+
463
+ /**
464
+ * Request parameters for getUserJWT operation in AuthenticationApi.
465
+ * @export
466
+ * @interface AuthenticationApiGetUserJWTRequest
467
+ */
468
+ export interface AuthenticationApiGetUserJWTRequest {
469
+ /**
470
+ *
471
+ * @type {string}
472
+ * @memberof AuthenticationApiGetUserJWT
473
+ */
474
+ readonly userId: string
475
+
476
+ /**
477
+ *
478
+ * @type {string}
479
+ * @memberof AuthenticationApiGetUserJWT
480
+ */
481
+ readonly userSecret: string
482
+ }
483
+
484
+ /**
485
+ * Request parameters for loginSnapTradeUser operation in AuthenticationApi.
486
+ * @export
487
+ * @interface AuthenticationApiLoginSnapTradeUserRequest
488
+ */
489
+ export interface AuthenticationApiLoginSnapTradeUserRequest {
490
+ /**
491
+ *
492
+ * @type {string}
493
+ * @memberof AuthenticationApiLoginSnapTradeUser
494
+ */
495
+ readonly userId: string
496
+
497
+ /**
498
+ *
499
+ * @type {string}
500
+ * @memberof AuthenticationApiLoginSnapTradeUser
501
+ */
502
+ readonly userSecret: string
503
+
504
+ /**
505
+ *
506
+ * @type {SnapTradeLoginUserRequestBody}
507
+ * @memberof AuthenticationApiLoginSnapTradeUser
508
+ */
509
+ readonly requestBody?: SnapTradeLoginUserRequestBody
510
+ }
511
+
512
+ /**
513
+ * Request parameters for registerSnapTradeUser operation in AuthenticationApi.
514
+ * @export
515
+ * @interface AuthenticationApiRegisterSnapTradeUserRequest
516
+ */
517
+ export interface AuthenticationApiRegisterSnapTradeUserRequest {
518
+ /**
519
+ *
520
+ * @type {SnapTradeRegisterUserRequestBody}
521
+ * @memberof AuthenticationApiRegisterSnapTradeUser
522
+ */
523
+ readonly requestBody: SnapTradeRegisterUserRequestBody
524
+ }
525
+
526
+ /**
527
+ * AuthenticationApi - object-oriented interface
528
+ * @export
529
+ * @class AuthenticationApi
530
+ * @extends {BaseAPI}
531
+ */
532
+ export class AuthenticationApi extends BaseAPI {
533
+ /**
534
+ *
535
+ * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
536
+ * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
537
+ * @param {*} [options] Override http request option.
538
+ * @throws {RequiredError}
539
+ * @memberof AuthenticationApi
540
+ */
541
+ public deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig) {
542
+ return AuthenticationApiFp(this.configuration).deleteSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
543
+ }
544
+
545
+ /**
546
+ *
547
+ * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
548
+ * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
549
+ * @param {*} [options] Override http request option.
550
+ * @throws {RequiredError}
551
+ * @memberof AuthenticationApi
552
+ */
553
+ public getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig) {
554
+ return AuthenticationApiFp(this.configuration).getUserJWT(requestParameters, options).then((request) => request(this.axios, this.basePath));
555
+ }
556
+
557
+ /**
558
+ *
559
+ * @summary Get a list of all SnapTrade users you\'ve registered on our platform
560
+ * @param {*} [options] Override http request option.
561
+ * @throws {RequiredError}
562
+ * @memberof AuthenticationApi
563
+ */
564
+ public listSnapTradeUsers(options?: AxiosRequestConfig) {
565
+ return AuthenticationApiFp(this.configuration).listSnapTradeUsers(options).then((request) => request(this.axios, this.basePath));
566
+ }
567
+
568
+ /**
569
+ *
570
+ * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
571
+ * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
572
+ * @param {*} [options] Override http request option.
573
+ * @throws {RequiredError}
574
+ * @memberof AuthenticationApi
575
+ */
576
+ public loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig) {
577
+ return AuthenticationApiFp(this.configuration).loginSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
578
+ }
579
+
580
+ /**
581
+ *
582
+ * @summary Register user with SnapTrade in order to create secure brokerage authorizations
583
+ * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
584
+ * @param {*} [options] Override http request option.
585
+ * @throws {RequiredError}
586
+ * @memberof AuthenticationApi
587
+ */
588
+ public registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig) {
589
+ return AuthenticationApiFp(this.configuration).registerSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
590
+ }
591
+ }