snaptrade-typescript-sdk 8.28.1 → 8.29.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 (297) hide show
  1. package/README.md +1719 -152
  2. package/dist/api/account-information-api-generated.d.ts +519 -529
  3. package/dist/api/account-information-api-generated.js +769 -769
  4. package/dist/api/account-information-api.d.ts +4 -4
  5. package/dist/api/account-information-api.js +22 -22
  6. package/dist/api/api-status-api-generated.d.ts +59 -69
  7. package/dist/api/api-status-api-generated.js +131 -131
  8. package/dist/api/api-status-api.d.ts +4 -4
  9. package/dist/api/api-status-api.js +22 -22
  10. package/dist/api/authentication-api-generated.d.ts +256 -266
  11. package/dist/api/authentication-api-generated.js +461 -461
  12. package/dist/api/authentication-api.d.ts +4 -4
  13. package/dist/api/authentication-api.js +22 -22
  14. package/dist/api/connections-api-generated.d.ts +264 -274
  15. package/dist/api/connections-api-generated.js +411 -411
  16. package/dist/api/connections-api.d.ts +4 -4
  17. package/dist/api/connections-api.js +22 -22
  18. package/dist/api/error-logs-api-generated.d.ts +83 -93
  19. package/dist/api/error-logs-api-generated.js +152 -152
  20. package/dist/api/error-logs-api.d.ts +4 -4
  21. package/dist/api/error-logs-api.js +22 -22
  22. package/dist/api/options-api-generated.d.ts +358 -368
  23. package/dist/api/options-api-generated.js +530 -530
  24. package/dist/api/options-api.d.ts +4 -4
  25. package/dist/api/options-api.js +22 -22
  26. package/dist/api/reference-data-api-generated.d.ts +457 -467
  27. package/dist/api/reference-data-api-generated.js +872 -872
  28. package/dist/api/reference-data-api.d.ts +4 -4
  29. package/dist/api/reference-data-api.js +22 -22
  30. package/dist/api/trading-api-generated.d.ts +392 -402
  31. package/dist/api/trading-api-generated.js +613 -613
  32. package/dist/api/trading-api.d.ts +4 -4
  33. package/dist/api/trading-api.js +22 -22
  34. package/dist/api/transactions-and-reporting-api-generated.d.ts +207 -217
  35. package/dist/api/transactions-and-reporting-api-generated.js +287 -287
  36. package/dist/api/transactions-and-reporting-api.d.ts +4 -4
  37. package/dist/api/transactions-and-reporting-api.js +22 -22
  38. package/dist/api.d.ts +9 -19
  39. package/dist/api.js +37 -37
  40. package/dist/base.d.ts +44 -54
  41. package/dist/base.js +60 -60
  42. package/dist/browser.js +1 -1
  43. package/dist/client-custom.d.ts +4 -4
  44. package/dist/client-custom.js +7 -7
  45. package/dist/client.d.ts +15 -25
  46. package/dist/client.js +32 -32
  47. package/dist/common.d.ts +61 -71
  48. package/dist/common.js +207 -207
  49. package/dist/configuration.d.ts +89 -99
  50. package/dist/configuration.js +53 -53
  51. package/dist/error.d.ts +46 -56
  52. package/dist/error.js +104 -104
  53. package/dist/index.d.ts +5 -15
  54. package/dist/index.js +33 -33
  55. package/dist/jest.config.d.ts +3 -3
  56. package/dist/jest.config.js +13 -13
  57. package/dist/mock.test.d.ts +1 -1
  58. package/dist/mock.test.js +29 -29
  59. package/dist/models/account-holdings-account.d.ts +43 -53
  60. package/dist/models/account-holdings-account.js +12 -14
  61. package/dist/models/account-holdings.d.ts +36 -46
  62. package/dist/models/account-holdings.js +12 -14
  63. package/dist/models/account-order-record-status.d.ts +6 -16
  64. package/dist/models/account-order-record-status.js +12 -14
  65. package/dist/models/account-order-record.d.ts +122 -132
  66. package/dist/models/account-order-record.js +12 -14
  67. package/dist/models/account-simple.d.ts +33 -43
  68. package/dist/models/account-simple.js +12 -14
  69. package/dist/models/account-sync-status.d.ts +14 -24
  70. package/dist/models/account-sync-status.js +12 -14
  71. package/dist/models/account.d.ts +72 -82
  72. package/dist/models/account.js +12 -14
  73. package/dist/models/action.d.ts +6 -16
  74. package/dist/models/action.js +12 -14
  75. package/dist/models/authentication-login-snap-trade-user200-response.d.ts +7 -17
  76. package/dist/models/authentication-login-snap-trade-user200-response.js +12 -14
  77. package/dist/models/balance.d.ts +21 -31
  78. package/dist/models/balance.js +12 -14
  79. package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +26 -36
  80. package/dist/models/brokerage-authorization-type-read-only-brokerage.js +12 -14
  81. package/dist/models/brokerage-authorization-type-read-only.d.ts +36 -46
  82. package/dist/models/brokerage-authorization-type-read-only.js +12 -14
  83. package/dist/models/brokerage-authorization-type.d.ts +16 -26
  84. package/dist/models/brokerage-authorization-type.js +12 -14
  85. package/dist/models/brokerage-authorization.d.ts +65 -75
  86. package/dist/models/brokerage-authorization.js +12 -14
  87. package/dist/models/brokerage-symbol-option-symbol.d.ts +64 -66
  88. package/dist/models/brokerage-symbol-option-symbol.js +12 -14
  89. package/dist/models/brokerage-symbol-symbol.d.ts +58 -68
  90. package/dist/models/brokerage-symbol-symbol.js +12 -14
  91. package/dist/models/brokerage-symbol.d.ts +47 -57
  92. package/dist/models/brokerage-symbol.js +12 -14
  93. package/dist/models/brokerage-type.d.ts +20 -30
  94. package/dist/models/brokerage-type.js +12 -14
  95. package/dist/models/brokerage.d.ts +117 -127
  96. package/dist/models/brokerage.js +12 -14
  97. package/dist/models/calculated-trade.d.ts +21 -31
  98. package/dist/models/calculated-trade.js +12 -14
  99. package/dist/models/cash-restriction.d.ts +40 -50
  100. package/dist/models/cash-restriction.js +12 -14
  101. package/dist/models/connections-session-events200-response-inner.d.ts +6 -16
  102. package/dist/models/connections-session-events200-response-inner.js +12 -14
  103. package/dist/models/currency.d.ts +26 -36
  104. package/dist/models/currency.js +12 -14
  105. package/dist/models/delete-user-response.d.ts +20 -30
  106. package/dist/models/delete-user-response.js +12 -14
  107. package/dist/models/dividend-at-date.d.ts +26 -36
  108. package/dist/models/dividend-at-date.js +12 -14
  109. package/dist/models/encrypted-response-encrypted-message-data.d.ts +26 -36
  110. package/dist/models/encrypted-response-encrypted-message-data.js +12 -14
  111. package/dist/models/encrypted-response.d.ts +20 -30
  112. package/dist/models/encrypted-response.js +12 -14
  113. package/dist/models/exchange-rate-pairs.d.ts +27 -37
  114. package/dist/models/exchange-rate-pairs.js +12 -14
  115. package/dist/models/exchange.d.ts +56 -66
  116. package/dist/models/exchange.js +12 -14
  117. package/dist/models/excluded-asset.d.ts +15 -25
  118. package/dist/models/excluded-asset.js +12 -14
  119. package/dist/models/index.d.ts +111 -111
  120. package/dist/models/index.js +127 -127
  121. package/dist/models/jwt.d.ts +14 -24
  122. package/dist/models/jwt.js +12 -14
  123. package/dist/models/login-redirect-uri.d.ts +19 -29
  124. package/dist/models/login-redirect-uri.js +12 -14
  125. package/dist/models/manual-trade-and-impact.d.ts +28 -38
  126. package/dist/models/manual-trade-and-impact.js +12 -14
  127. package/dist/models/manual-trade-balance.d.ts +28 -38
  128. package/dist/models/manual-trade-balance.js +12 -14
  129. package/dist/models/manual-trade-form.d.ts +58 -68
  130. package/dist/models/manual-trade-form.js +12 -14
  131. package/dist/models/manual-trade-symbol.d.ts +45 -55
  132. package/dist/models/manual-trade-symbol.js +12 -14
  133. package/dist/models/manual-trade.d.ts +60 -70
  134. package/dist/models/manual-trade.js +12 -14
  135. package/dist/models/model-asset-class-details.d.ts +22 -32
  136. package/dist/models/model-asset-class-details.js +12 -14
  137. package/dist/models/model-asset-class-target.d.ts +15 -25
  138. package/dist/models/model-asset-class-target.js +12 -14
  139. package/dist/models/model-asset-class.d.ts +20 -30
  140. package/dist/models/model-asset-class.js +12 -14
  141. package/dist/models/model-portfolio-asset-class.d.ts +21 -31
  142. package/dist/models/model-portfolio-asset-class.js +12 -14
  143. package/dist/models/model-portfolio-details.d.ts +29 -39
  144. package/dist/models/model-portfolio-details.js +12 -14
  145. package/dist/models/model-portfolio-security.d.ts +21 -31
  146. package/dist/models/model-portfolio-security.js +12 -14
  147. package/dist/models/model-portfolio.d.ts +28 -38
  148. package/dist/models/model-portfolio.js +12 -14
  149. package/dist/models/model400-failed-request-response.d.ts +20 -30
  150. package/dist/models/model400-failed-request-response.js +12 -14
  151. package/dist/models/model401-failed-request-response.d.ts +20 -30
  152. package/dist/models/model401-failed-request-response.js +12 -14
  153. package/dist/models/model403-failed-request-response.d.ts +20 -30
  154. package/dist/models/model403-failed-request-response.js +12 -14
  155. package/dist/models/model404-failed-request-response.d.ts +20 -30
  156. package/dist/models/model404-failed-request-response.js +12 -14
  157. package/dist/models/monthly-dividends.d.ts +21 -31
  158. package/dist/models/monthly-dividends.js +12 -14
  159. package/dist/models/net-contributions.d.ts +26 -36
  160. package/dist/models/net-contributions.js +12 -14
  161. package/dist/models/net-dividend.d.ts +27 -37
  162. package/dist/models/net-dividend.js +12 -14
  163. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +26 -36
  164. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +12 -14
  165. package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +27 -37
  166. package/dist/models/option-chain-inner-chain-per-root-inner.js +12 -14
  167. package/dist/models/option-chain-inner.d.ts +39 -49
  168. package/dist/models/option-chain-inner.js +12 -14
  169. package/dist/models/option-leg.d.ts +28 -38
  170. package/dist/models/option-leg.js +12 -14
  171. package/dist/models/option-strategy-legs-inner.d.ts +31 -41
  172. package/dist/models/option-strategy-legs-inner.js +12 -14
  173. package/dist/models/option-strategy.d.ts +40 -50
  174. package/dist/models/option-strategy.js +12 -14
  175. package/dist/models/options-get-option-strategy-request.d.ts +28 -38
  176. package/dist/models/options-get-option-strategy-request.js +12 -14
  177. package/dist/models/options-holdings.d.ts +46 -56
  178. package/dist/models/options-holdings.js +12 -14
  179. package/dist/models/options-place-option-strategy-request.d.ts +28 -38
  180. package/dist/models/options-place-option-strategy-request.js +12 -14
  181. package/dist/models/options-position-currency.d.ts +25 -35
  182. package/dist/models/options-position-currency.js +12 -14
  183. package/dist/models/options-position.d.ts +52 -62
  184. package/dist/models/options-position.js +12 -14
  185. package/dist/models/options-symbol.d.ts +65 -67
  186. package/dist/models/options-symbol.js +12 -14
  187. package/dist/models/order-type.d.ts +6 -16
  188. package/dist/models/order-type.js +12 -14
  189. package/dist/models/partner-data.d.ts +81 -91
  190. package/dist/models/partner-data.js +12 -14
  191. package/dist/models/past-value.d.ts +26 -36
  192. package/dist/models/past-value.js +12 -14
  193. package/dist/models/performance-custom.d.ts +127 -137
  194. package/dist/models/performance-custom.js +12 -14
  195. package/dist/models/portfolio-group-info.d.ts +82 -92
  196. package/dist/models/portfolio-group-info.js +12 -14
  197. package/dist/models/portfolio-group-position.d.ts +27 -37
  198. package/dist/models/portfolio-group-position.js +12 -14
  199. package/dist/models/portfolio-group-settings.d.ts +39 -49
  200. package/dist/models/portfolio-group-settings.js +12 -14
  201. package/dist/models/portfolio-group.d.ts +20 -30
  202. package/dist/models/portfolio-group.js +12 -14
  203. package/dist/models/position-symbol.d.ts +45 -55
  204. package/dist/models/position-symbol.js +12 -14
  205. package/dist/models/position.d.ts +45 -55
  206. package/dist/models/position.js +12 -14
  207. package/dist/models/redirect-tokenand-pin.d.ts +20 -30
  208. package/dist/models/redirect-tokenand-pin.js +12 -14
  209. package/dist/models/security-type.d.ts +32 -42
  210. package/dist/models/security-type.js +12 -14
  211. package/dist/models/session-event.d.ts +52 -62
  212. package/dist/models/session-event.js +12 -14
  213. package/dist/models/snap-trade-apidisclaimer-accept-status.d.ts +20 -30
  214. package/dist/models/snap-trade-apidisclaimer-accept-status.js +12 -14
  215. package/dist/models/snap-trade-holdings-account-account-id.d.ts +65 -75
  216. package/dist/models/snap-trade-holdings-account-account-id.js +12 -14
  217. package/dist/models/snap-trade-holdings-account.d.ts +60 -70
  218. package/dist/models/snap-trade-holdings-account.js +12 -14
  219. package/dist/models/snap-trade-holdings-total-value.d.ts +20 -30
  220. package/dist/models/snap-trade-holdings-total-value.js +12 -14
  221. package/dist/models/snap-trade-login-user-request-body.d.ts +39 -49
  222. package/dist/models/snap-trade-login-user-request-body.js +12 -14
  223. package/dist/models/snap-trade-register-user-request-body.d.ts +19 -29
  224. package/dist/models/snap-trade-register-user-request-body.js +12 -14
  225. package/dist/models/status.d.ts +26 -36
  226. package/dist/models/status.js +12 -14
  227. package/dist/models/strategy-impact-legs-inner.d.ts +50 -60
  228. package/dist/models/strategy-impact-legs-inner.js +12 -14
  229. package/dist/models/strategy-impact.d.ts +75 -85
  230. package/dist/models/strategy-impact.js +12 -14
  231. package/dist/models/strategy-order-place-orders-inner-legs-inner.d.ts +50 -60
  232. package/dist/models/strategy-order-place-orders-inner-legs-inner.js +12 -14
  233. package/dist/models/strategy-order-place-orders-inner.d.ts +267 -277
  234. package/dist/models/strategy-order-place-orders-inner.js +12 -14
  235. package/dist/models/strategy-order-place.d.ts +21 -31
  236. package/dist/models/strategy-order-place.js +12 -14
  237. package/dist/models/strategy-order-record.d.ts +79 -89
  238. package/dist/models/strategy-order-record.js +12 -14
  239. package/dist/models/strategy-quotes-greek.d.ts +38 -48
  240. package/dist/models/strategy-quotes-greek.js +12 -14
  241. package/dist/models/strategy-quotes.d.ts +46 -56
  242. package/dist/models/strategy-quotes.js +12 -14
  243. package/dist/models/sub-period-return-rate.d.ts +26 -36
  244. package/dist/models/sub-period-return-rate.js +12 -14
  245. package/dist/models/symbol-query.d.ts +13 -23
  246. package/dist/models/symbol-query.js +12 -14
  247. package/dist/models/symbol.d.ts +53 -63
  248. package/dist/models/symbol.js +12 -14
  249. package/dist/models/symbols-quotes-inner.d.ts +44 -54
  250. package/dist/models/symbols-quotes-inner.js +12 -14
  251. package/dist/models/target-asset.d.ts +47 -57
  252. package/dist/models/target-asset.js +12 -14
  253. package/dist/models/time-in-force.d.ts +6 -16
  254. package/dist/models/time-in-force.js +12 -14
  255. package/dist/models/trade-execution-status.d.ts +70 -80
  256. package/dist/models/trade-execution-status.js +12 -14
  257. package/dist/models/trade-impact.d.ts +40 -50
  258. package/dist/models/trade-impact.js +12 -14
  259. package/dist/models/trade.d.ts +61 -71
  260. package/dist/models/trade.js +12 -14
  261. package/dist/models/trading-cancel-user-account-order-request.d.ts +13 -23
  262. package/dist/models/trading-cancel-user-account-order-request.js +12 -14
  263. package/dist/models/trading-place-ocoorder-request.d.ts +19 -29
  264. package/dist/models/trading-place-ocoorder-request.js +12 -14
  265. package/dist/models/transactions-status.d.ts +19 -29
  266. package/dist/models/transactions-status.js +12 -14
  267. package/dist/models/underlying-symbol.d.ts +53 -63
  268. package/dist/models/underlying-symbol.js +12 -14
  269. package/dist/models/universal-activity.d.ts +114 -124
  270. package/dist/models/universal-activity.js +12 -14
  271. package/dist/models/universal-symbol-ticker.d.ts +59 -69
  272. package/dist/models/universal-symbol-ticker.js +12 -14
  273. package/dist/models/universal-symbol.d.ts +59 -69
  274. package/dist/models/universal-symbol.js +12 -14
  275. package/dist/models/user-error-log.d.ts +44 -54
  276. package/dist/models/user-error-log.js +12 -14
  277. package/dist/models/user-idand-secret.d.ts +20 -30
  278. package/dist/models/user-idand-secret.js +12 -14
  279. package/dist/models/user-settings.d.ts +69 -79
  280. package/dist/models/user-settings.js +12 -14
  281. package/dist/models/usexchange.d.ts +62 -72
  282. package/dist/models/usexchange.js +12 -14
  283. package/dist/pagination/page-types.d.ts +16 -26
  284. package/dist/pagination/page-types.js +12 -12
  285. package/dist/pagination/page.d.ts +25 -35
  286. package/dist/pagination/page.js +32 -32
  287. package/dist/pagination/pageable.d.ts +47 -57
  288. package/dist/pagination/pageable.js +70 -70
  289. package/dist/pagination/paginate.d.ts +6 -16
  290. package/dist/pagination/paginate.js +39 -39
  291. package/dist/requestAfterHook.d.ts +8 -8
  292. package/dist/requestAfterHook.js +82 -82
  293. package/dist/requestBeforeHook.d.ts +9 -9
  294. package/dist/requestBeforeHook.js +8 -8
  295. package/dist/requestBeforeUrlHook.d.ts +7 -7
  296. package/dist/requestBeforeUrlHook.js +5 -5
  297. package/package.json +48 -45
@@ -1,36 +1,26 @@
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
- * Do not edit the class manually.
10
- */
11
- /**
12
- *
13
- * @export
14
- * @interface PastValue
15
- */
16
- export interface PastValue {
17
- [key: string]: any;
18
- /**
19
- * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
20
- * @type {string}
21
- * @memberof PastValue
22
- */
23
- 'date'?: string;
24
- /**
25
- *
26
- * @type {number}
27
- * @memberof PastValue
28
- */
29
- 'value'?: number;
30
- /**
31
- *
32
- * @type {string}
33
- * @memberof PastValue
34
- */
35
- 'currency'?: string;
36
- }
1
+ /**
2
+ *
3
+ * @export
4
+ * @interface PastValue
5
+ */
6
+ export interface PastValue {
7
+ [key: string]: any;
8
+ /**
9
+ * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
10
+ * @type {string}
11
+ * @memberof PastValue
12
+ */
13
+ 'date'?: string;
14
+ /**
15
+ *
16
+ * @type {number}
17
+ * @memberof PastValue
18
+ */
19
+ 'value'?: number;
20
+ /**
21
+ *
22
+ * @type {string}
23
+ * @memberof PastValue
24
+ */
25
+ 'currency'?: string;
26
+ }
@@ -1,14 +1,12 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
14
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ /*
3
+ SnapTrade
4
+
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
+ */
12
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,137 +1,127 @@
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
- * Do not edit the class manually.
10
- */
11
- import { MonthlyDividends } from './monthly-dividends';
12
- import { NetContributions } from './net-contributions';
13
- import { NetDividend } from './net-dividend';
14
- import { PastValue } from './past-value';
15
- import { SubPeriodReturnRate } from './sub-period-return-rate';
16
- /**
17
- * Performance Custom Response Object
18
- * @export
19
- * @interface PerformanceCustom
20
- */
21
- export interface PerformanceCustom {
22
- [key: string]: any;
23
- /**
24
- *
25
- * @type {Array<PastValue>}
26
- * @memberof PerformanceCustom
27
- */
28
- 'totalEquityTimeframe'?: Array<PastValue>;
29
- /**
30
- *
31
- * @type {NetContributions}
32
- * @memberof PerformanceCustom
33
- */
34
- 'contributions'?: NetContributions;
35
- /**
36
- *
37
- * @type {Array<PastValue>}
38
- * @memberof PerformanceCustom
39
- */
40
- 'contributionTimeframe'?: Array<PastValue>;
41
- /**
42
- *
43
- * @type {Array<PastValue>}
44
- * @memberof PerformanceCustom
45
- */
46
- 'contributionTimeframeCumulative'?: Array<PastValue>;
47
- /**
48
- *
49
- * @type {Array<PastValue>}
50
- * @memberof PerformanceCustom
51
- */
52
- 'withdrawalTimeframe'?: Array<PastValue>;
53
- /**
54
- * Current streak of cosecutive months where contributions were made
55
- * @type {number}
56
- * @memberof PerformanceCustom
57
- */
58
- 'contributionStreak'?: number | null;
59
- /**
60
- * Number of months in the timeframe with contributions
61
- * @type {number}
62
- * @memberof PerformanceCustom
63
- */
64
- 'contributionMonthsContributed'?: number | null;
65
- /**
66
- * Total months in timeframe
67
- * @type {number}
68
- * @memberof PerformanceCustom
69
- */
70
- 'contributionTotalMonths'?: number | null;
71
- /**
72
- *
73
- * @type {Array<NetDividend>}
74
- * @memberof PerformanceCustom
75
- */
76
- 'dividends'?: Array<NetDividend>;
77
- /**
78
- * Total dividends received over the timeframe
79
- * @type {number}
80
- * @memberof PerformanceCustom
81
- */
82
- 'dividendIncome'?: number | null;
83
- /**
84
- * Average dividends received per month over the timeframe
85
- * @type {number}
86
- * @memberof PerformanceCustom
87
- */
88
- 'monthlyDividends'?: number | null;
89
- /**
90
- * list of tickers which may not be supported or may not have accurate price data
91
- * @type {Array<string>}
92
- * @memberof PerformanceCustom
93
- */
94
- 'badTickers'?: Array<string>;
95
- /**
96
- *
97
- * @type {Array<MonthlyDividends>}
98
- * @memberof PerformanceCustom
99
- */
100
- 'dividendTimeline'?: Array<MonthlyDividends>;
101
- /**
102
- * commissions incurred during the timeframe
103
- * @type {number}
104
- * @memberof PerformanceCustom
105
- */
106
- 'commissions'?: number | null;
107
- /**
108
- * forex fees incurred during the timeframe
109
- * @type {number}
110
- * @memberof PerformanceCustom
111
- */
112
- 'forexFees'?: number | null;
113
- /**
114
- * other fees incurred during the timeframe
115
- * @type {number}
116
- * @memberof PerformanceCustom
117
- */
118
- 'fees'?: number | null;
119
- /**
120
- * The return rate over the timeframe. Annualized if timeframe is longer than 1 year
121
- * @type {number}
122
- * @memberof PerformanceCustom
123
- */
124
- 'rateOfReturn'?: number | null;
125
- /**
126
- *
127
- * @type {Array<SubPeriodReturnRate>}
128
- * @memberof PerformanceCustom
129
- */
130
- 'returnRateTimeframe'?: Array<SubPeriodReturnRate>;
131
- /**
132
- * Whether the user has detailed mode enabled (more frequent data points for totalEquity and contribution timeframes)
133
- * @type {boolean}
134
- * @memberof PerformanceCustom
135
- */
136
- 'detailedMode'?: boolean;
137
- }
1
+ import { MonthlyDividends } from './monthly-dividends';
2
+ import { NetContributions } from './net-contributions';
3
+ import { NetDividend } from './net-dividend';
4
+ import { PastValue } from './past-value';
5
+ import { SubPeriodReturnRate } from './sub-period-return-rate';
6
+ /**
7
+ * Performance Custom Response Object
8
+ * @export
9
+ * @interface PerformanceCustom
10
+ */
11
+ export interface PerformanceCustom {
12
+ [key: string]: any;
13
+ /**
14
+ *
15
+ * @type {Array<PastValue>}
16
+ * @memberof PerformanceCustom
17
+ */
18
+ 'totalEquityTimeframe'?: Array<PastValue>;
19
+ /**
20
+ *
21
+ * @type {NetContributions}
22
+ * @memberof PerformanceCustom
23
+ */
24
+ 'contributions'?: NetContributions;
25
+ /**
26
+ *
27
+ * @type {Array<PastValue>}
28
+ * @memberof PerformanceCustom
29
+ */
30
+ 'contributionTimeframe'?: Array<PastValue>;
31
+ /**
32
+ *
33
+ * @type {Array<PastValue>}
34
+ * @memberof PerformanceCustom
35
+ */
36
+ 'contributionTimeframeCumulative'?: Array<PastValue>;
37
+ /**
38
+ *
39
+ * @type {Array<PastValue>}
40
+ * @memberof PerformanceCustom
41
+ */
42
+ 'withdrawalTimeframe'?: Array<PastValue>;
43
+ /**
44
+ * Current streak of cosecutive months where contributions were made
45
+ * @type {number}
46
+ * @memberof PerformanceCustom
47
+ */
48
+ 'contributionStreak'?: number | null;
49
+ /**
50
+ * Number of months in the timeframe with contributions
51
+ * @type {number}
52
+ * @memberof PerformanceCustom
53
+ */
54
+ 'contributionMonthsContributed'?: number | null;
55
+ /**
56
+ * Total months in timeframe
57
+ * @type {number}
58
+ * @memberof PerformanceCustom
59
+ */
60
+ 'contributionTotalMonths'?: number | null;
61
+ /**
62
+ *
63
+ * @type {Array<NetDividend>}
64
+ * @memberof PerformanceCustom
65
+ */
66
+ 'dividends'?: Array<NetDividend>;
67
+ /**
68
+ * Total dividends received over the timeframe
69
+ * @type {number}
70
+ * @memberof PerformanceCustom
71
+ */
72
+ 'dividendIncome'?: number | null;
73
+ /**
74
+ * Average dividends received per month over the timeframe
75
+ * @type {number}
76
+ * @memberof PerformanceCustom
77
+ */
78
+ 'monthlyDividends'?: number | null;
79
+ /**
80
+ * list of tickers which may not be supported or may not have accurate price data
81
+ * @type {Array<string>}
82
+ * @memberof PerformanceCustom
83
+ */
84
+ 'badTickers'?: Array<string>;
85
+ /**
86
+ *
87
+ * @type {Array<MonthlyDividends>}
88
+ * @memberof PerformanceCustom
89
+ */
90
+ 'dividendTimeline'?: Array<MonthlyDividends>;
91
+ /**
92
+ * commissions incurred during the timeframe
93
+ * @type {number}
94
+ * @memberof PerformanceCustom
95
+ */
96
+ 'commissions'?: number | null;
97
+ /**
98
+ * forex fees incurred during the timeframe
99
+ * @type {number}
100
+ * @memberof PerformanceCustom
101
+ */
102
+ 'forexFees'?: number | null;
103
+ /**
104
+ * other fees incurred during the timeframe
105
+ * @type {number}
106
+ * @memberof PerformanceCustom
107
+ */
108
+ 'fees'?: number | null;
109
+ /**
110
+ * The return rate over the timeframe. Annualized if timeframe is longer than 1 year
111
+ * @type {number}
112
+ * @memberof PerformanceCustom
113
+ */
114
+ 'rateOfReturn'?: number | null;
115
+ /**
116
+ *
117
+ * @type {Array<SubPeriodReturnRate>}
118
+ * @memberof PerformanceCustom
119
+ */
120
+ 'returnRateTimeframe'?: Array<SubPeriodReturnRate>;
121
+ /**
122
+ * Whether the user has detailed mode enabled (more frequent data points for totalEquity and contribution timeframes)
123
+ * @type {boolean}
124
+ * @memberof PerformanceCustom
125
+ */
126
+ 'detailedMode'?: boolean;
127
+ }
@@ -1,14 +1,12 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
14
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ /*
3
+ SnapTrade
4
+
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
+ */
12
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,92 +1,82 @@
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
- * Do not edit the class manually.
10
- */
11
- import { Balance } from './balance';
12
- import { BrokerageAuthorization } from './brokerage-authorization';
13
- import { CalculatedTrade } from './calculated-trade';
14
- import { ExcludedAsset } from './excluded-asset';
15
- import { PortfolioGroupSettings } from './portfolio-group-settings';
16
- import { Position } from './position';
17
- import { TargetAsset } from './target-asset';
18
- import { UniversalSymbol } from './universal-symbol';
19
- /**
20
- * Summary of all relevant information about a portfolio group.
21
- * @export
22
- * @interface PortfolioGroupInfo
23
- */
24
- export interface PortfolioGroupInfo {
25
- [key: string]: any;
26
- /**
27
- *
28
- * @type {Array<UniversalSymbol>}
29
- * @memberof PortfolioGroupInfo
30
- */
31
- 'symbols'?: Array<UniversalSymbol>;
32
- /**
33
- *
34
- * @type {Array<UniversalSymbol>}
35
- * @memberof PortfolioGroupInfo
36
- */
37
- 'quotable_symbols'?: Array<UniversalSymbol>;
38
- /**
39
- *
40
- * @type {Array<Balance>}
41
- * @memberof PortfolioGroupInfo
42
- */
43
- 'balances'?: Array<Balance>;
44
- /**
45
- *
46
- * @type {Array<Position>}
47
- * @memberof PortfolioGroupInfo
48
- */
49
- 'positions'?: Array<Position>;
50
- /**
51
- *
52
- * @type {Array<TargetAsset>}
53
- * @memberof PortfolioGroupInfo
54
- */
55
- 'target_positions'?: Array<TargetAsset>;
56
- /**
57
- *
58
- * @type {Array<Position>}
59
- * @memberof PortfolioGroupInfo
60
- */
61
- 'ideal_positions'?: Array<Position>;
62
- /**
63
- *
64
- * @type {Array<ExcludedAsset>}
65
- * @memberof PortfolioGroupInfo
66
- */
67
- 'excluded_positions'?: Array<ExcludedAsset>;
68
- /**
69
- *
70
- * @type {Array<CalculatedTrade>}
71
- * @memberof PortfolioGroupInfo
72
- */
73
- 'calculated_trades'?: Array<CalculatedTrade>;
74
- /**
75
- *
76
- * @type {Array<BrokerageAuthorization>}
77
- * @memberof PortfolioGroupInfo
78
- */
79
- 'brokerage_authorizations'?: Array<BrokerageAuthorization>;
80
- /**
81
- *
82
- * @type {number}
83
- * @memberof PortfolioGroupInfo
84
- */
85
- 'accuracy'?: number;
86
- /**
87
- *
88
- * @type {PortfolioGroupSettings}
89
- * @memberof PortfolioGroupInfo
90
- */
91
- 'settings'?: PortfolioGroupSettings;
92
- }
1
+ import { Balance } from './balance';
2
+ import { BrokerageAuthorization } from './brokerage-authorization';
3
+ import { CalculatedTrade } from './calculated-trade';
4
+ import { ExcludedAsset } from './excluded-asset';
5
+ import { PortfolioGroupSettings } from './portfolio-group-settings';
6
+ import { Position } from './position';
7
+ import { TargetAsset } from './target-asset';
8
+ import { UniversalSymbol } from './universal-symbol';
9
+ /**
10
+ * Summary of all relevant information about a portfolio group.
11
+ * @export
12
+ * @interface PortfolioGroupInfo
13
+ */
14
+ export interface PortfolioGroupInfo {
15
+ [key: string]: any;
16
+ /**
17
+ *
18
+ * @type {Array<UniversalSymbol>}
19
+ * @memberof PortfolioGroupInfo
20
+ */
21
+ 'symbols'?: Array<UniversalSymbol>;
22
+ /**
23
+ *
24
+ * @type {Array<UniversalSymbol>}
25
+ * @memberof PortfolioGroupInfo
26
+ */
27
+ 'quotable_symbols'?: Array<UniversalSymbol>;
28
+ /**
29
+ *
30
+ * @type {Array<Balance>}
31
+ * @memberof PortfolioGroupInfo
32
+ */
33
+ 'balances'?: Array<Balance>;
34
+ /**
35
+ *
36
+ * @type {Array<Position>}
37
+ * @memberof PortfolioGroupInfo
38
+ */
39
+ 'positions'?: Array<Position>;
40
+ /**
41
+ *
42
+ * @type {Array<TargetAsset>}
43
+ * @memberof PortfolioGroupInfo
44
+ */
45
+ 'target_positions'?: Array<TargetAsset>;
46
+ /**
47
+ *
48
+ * @type {Array<Position>}
49
+ * @memberof PortfolioGroupInfo
50
+ */
51
+ 'ideal_positions'?: Array<Position>;
52
+ /**
53
+ *
54
+ * @type {Array<ExcludedAsset>}
55
+ * @memberof PortfolioGroupInfo
56
+ */
57
+ 'excluded_positions'?: Array<ExcludedAsset>;
58
+ /**
59
+ *
60
+ * @type {Array<CalculatedTrade>}
61
+ * @memberof PortfolioGroupInfo
62
+ */
63
+ 'calculated_trades'?: Array<CalculatedTrade>;
64
+ /**
65
+ *
66
+ * @type {Array<BrokerageAuthorization>}
67
+ * @memberof PortfolioGroupInfo
68
+ */
69
+ 'brokerage_authorizations'?: Array<BrokerageAuthorization>;
70
+ /**
71
+ *
72
+ * @type {number}
73
+ * @memberof PortfolioGroupInfo
74
+ */
75
+ 'accuracy'?: number;
76
+ /**
77
+ *
78
+ * @type {PortfolioGroupSettings}
79
+ * @memberof PortfolioGroupInfo
80
+ */
81
+ 'settings'?: PortfolioGroupSettings;
82
+ }
@@ -1,14 +1,12 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
14
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ /*
3
+ SnapTrade
4
+
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
+ */
12
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,37 +1,27 @@
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
- * Do not edit the class manually.
10
- */
11
- import { UniversalSymbol } from './universal-symbol';
12
- /**
13
- * Details of a security held
14
- * @export
15
- * @interface PortfolioGroupPosition
16
- */
17
- export interface PortfolioGroupPosition {
18
- [key: string]: any;
19
- /**
20
- *
21
- * @type {UniversalSymbol}
22
- * @memberof PortfolioGroupPosition
23
- */
24
- 'symbol'?: UniversalSymbol;
25
- /**
26
- * Last known market price for the symbol
27
- * @type {number}
28
- * @memberof PortfolioGroupPosition
29
- */
30
- 'price'?: number | null;
31
- /**
32
- *
33
- * @type {number}
34
- * @memberof PortfolioGroupPosition
35
- */
36
- 'units'?: number;
37
- }
1
+ import { UniversalSymbol } from './universal-symbol';
2
+ /**
3
+ * Details of a security held
4
+ * @export
5
+ * @interface PortfolioGroupPosition
6
+ */
7
+ export interface PortfolioGroupPosition {
8
+ [key: string]: any;
9
+ /**
10
+ *
11
+ * @type {UniversalSymbol}
12
+ * @memberof PortfolioGroupPosition
13
+ */
14
+ 'symbol'?: UniversalSymbol;
15
+ /**
16
+ * Last known market price for the symbol
17
+ * @type {number}
18
+ * @memberof PortfolioGroupPosition
19
+ */
20
+ 'price'?: number | null;
21
+ /**
22
+ *
23
+ * @type {number}
24
+ * @memberof PortfolioGroupPosition
25
+ */
26
+ 'units'?: number;
27
+ }