snaptrade-typescript-sdk 8.18.0 → 8.19.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 (284) hide show
  1. package/README.md +147 -147
  2. package/dist/api/account-information-api-custom.d.ts +3 -3
  3. package/dist/api/account-information-api-custom.js +27 -27
  4. package/dist/api/account-information-api.d.ts +526 -526
  5. package/dist/api/account-information-api.js +1049 -1049
  6. package/dist/api/api-status-api-custom.d.ts +3 -3
  7. package/dist/api/api-status-api-custom.js +27 -27
  8. package/dist/api/api-status-api.d.ts +70 -70
  9. package/dist/api/api-status-api.js +203 -203
  10. package/dist/api/authentication-api-custom.d.ts +3 -3
  11. package/dist/api/authentication-api-custom.js +27 -27
  12. package/dist/api/authentication-api.d.ts +267 -267
  13. package/dist/api/authentication-api.js +661 -661
  14. package/dist/api/connections-api-custom.d.ts +3 -3
  15. package/dist/api/connections-api-custom.js +27 -27
  16. package/dist/api/connections-api.d.ts +275 -275
  17. package/dist/api/connections-api.js +583 -583
  18. package/dist/api/error-logs-api-custom.d.ts +3 -3
  19. package/dist/api/error-logs-api-custom.js +27 -27
  20. package/dist/api/error-logs-api.d.ts +94 -94
  21. package/dist/api/error-logs-api.js +240 -240
  22. package/dist/api/options-api-custom.d.ts +3 -3
  23. package/dist/api/options-api-custom.js +27 -27
  24. package/dist/api/options-api.d.ts +369 -369
  25. package/dist/api/options-api.js +730 -730
  26. package/dist/api/reference-data-api-custom.d.ts +3 -3
  27. package/dist/api/reference-data-api-custom.js +27 -27
  28. package/dist/api/reference-data-api.d.ts +468 -468
  29. package/dist/api/reference-data-api.js +1246 -1246
  30. package/dist/api/trading-api-custom.d.ts +3 -3
  31. package/dist/api/trading-api-custom.js +27 -27
  32. package/dist/api/trading-api.d.ts +403 -403
  33. package/dist/api/trading-api.js +841 -841
  34. package/dist/api/transactions-and-reporting-api-custom.d.ts +3 -3
  35. package/dist/api/transactions-and-reporting-api-custom.js +27 -27
  36. package/dist/api/transactions-and-reporting-api.d.ts +218 -218
  37. package/dist/api/transactions-and-reporting-api.js +403 -403
  38. package/dist/api.d.ts +19 -19
  39. package/dist/api.js +37 -37
  40. package/dist/base.d.ts +54 -54
  41. package/dist/base.js +81 -81
  42. package/dist/client-custom.d.ts +4 -4
  43. package/dist/client-custom.js +9 -9
  44. package/dist/client.d.ts +25 -25
  45. package/dist/client.js +50 -50
  46. package/dist/common.d.ts +67 -67
  47. package/dist/common.js +236 -236
  48. package/dist/configuration.d.ts +99 -99
  49. package/dist/configuration.js +55 -55
  50. package/dist/index.d.ts +14 -14
  51. package/dist/index.js +32 -32
  52. package/dist/jest.config.d.ts +3 -3
  53. package/dist/jest.config.js +13 -13
  54. package/dist/models/account-holdings-account.d.ts +53 -53
  55. package/dist/models/account-holdings-account.js +14 -14
  56. package/dist/models/account-holdings.d.ts +46 -46
  57. package/dist/models/account-holdings.js +14 -14
  58. package/dist/models/account-order-record-status.d.ts +16 -16
  59. package/dist/models/account-order-record-status.js +14 -14
  60. package/dist/models/account-order-record.d.ts +132 -132
  61. package/dist/models/account-order-record.js +14 -14
  62. package/dist/models/account-simple.d.ts +43 -43
  63. package/dist/models/account-simple.js +14 -14
  64. package/dist/models/account-sync-status.d.ts +24 -24
  65. package/dist/models/account-sync-status.js +14 -14
  66. package/dist/models/account.d.ts +82 -82
  67. package/dist/models/account.js +14 -14
  68. package/dist/models/action.d.ts +16 -16
  69. package/dist/models/action.js +14 -14
  70. package/dist/models/authentication-login-snap-trade-user200-response.d.ts +17 -17
  71. package/dist/models/authentication-login-snap-trade-user200-response.js +14 -14
  72. package/dist/models/balance.d.ts +31 -31
  73. package/dist/models/balance.js +14 -14
  74. package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +36 -36
  75. package/dist/models/brokerage-authorization-type-read-only-brokerage.js +14 -14
  76. package/dist/models/brokerage-authorization-type-read-only.d.ts +46 -46
  77. package/dist/models/brokerage-authorization-type-read-only.js +14 -14
  78. package/dist/models/brokerage-authorization-type.d.ts +26 -26
  79. package/dist/models/brokerage-authorization-type.js +14 -14
  80. package/dist/models/brokerage-authorization.d.ts +75 -75
  81. package/dist/models/brokerage-authorization.js +14 -14
  82. package/dist/models/brokerage-symbol.d.ts +50 -50
  83. package/dist/models/brokerage-symbol.js +14 -14
  84. package/dist/models/brokerage-type.d.ts +30 -30
  85. package/dist/models/brokerage-type.js +14 -14
  86. package/dist/models/brokerage.d.ts +127 -127
  87. package/dist/models/brokerage.js +14 -14
  88. package/dist/models/calculated-trade.d.ts +31 -31
  89. package/dist/models/calculated-trade.js +14 -14
  90. package/dist/models/cash-restriction.d.ts +50 -50
  91. package/dist/models/cash-restriction.js +14 -14
  92. package/dist/models/connections-session-events200-response-inner.d.ts +16 -16
  93. package/dist/models/connections-session-events200-response-inner.js +14 -14
  94. package/dist/models/currency.d.ts +36 -36
  95. package/dist/models/currency.js +14 -14
  96. package/dist/models/delete-user-response.d.ts +30 -30
  97. package/dist/models/delete-user-response.js +14 -14
  98. package/dist/models/dividend-at-date.d.ts +36 -36
  99. package/dist/models/dividend-at-date.js +14 -14
  100. package/dist/models/encrypted-response-encrypted-message-data.d.ts +36 -36
  101. package/dist/models/encrypted-response-encrypted-message-data.js +14 -14
  102. package/dist/models/encrypted-response.d.ts +30 -30
  103. package/dist/models/encrypted-response.js +14 -14
  104. package/dist/models/exchange-rate-pairs.d.ts +37 -37
  105. package/dist/models/exchange-rate-pairs.js +14 -14
  106. package/dist/models/exchange.d.ts +66 -66
  107. package/dist/models/exchange.js +14 -14
  108. package/dist/models/excluded-asset.d.ts +25 -25
  109. package/dist/models/excluded-asset.js +14 -14
  110. package/dist/models/index.d.ts +108 -108
  111. package/dist/models/index.js +124 -124
  112. package/dist/models/jwt.d.ts +24 -24
  113. package/dist/models/jwt.js +14 -14
  114. package/dist/models/login-redirect-uri.d.ts +29 -29
  115. package/dist/models/login-redirect-uri.js +14 -14
  116. package/dist/models/manual-trade-and-impact.d.ts +38 -38
  117. package/dist/models/manual-trade-and-impact.js +14 -14
  118. package/dist/models/manual-trade-balance.d.ts +38 -38
  119. package/dist/models/manual-trade-balance.js +14 -14
  120. package/dist/models/manual-trade-form.d.ts +68 -68
  121. package/dist/models/manual-trade-form.js +14 -14
  122. package/dist/models/manual-trade-symbol.d.ts +55 -55
  123. package/dist/models/manual-trade-symbol.js +14 -14
  124. package/dist/models/manual-trade.d.ts +70 -70
  125. package/dist/models/manual-trade.js +14 -14
  126. package/dist/models/model-asset-class-details.d.ts +32 -32
  127. package/dist/models/model-asset-class-details.js +14 -14
  128. package/dist/models/model-asset-class-target.d.ts +25 -25
  129. package/dist/models/model-asset-class-target.js +14 -14
  130. package/dist/models/model-asset-class.d.ts +30 -30
  131. package/dist/models/model-asset-class.js +14 -14
  132. package/dist/models/model-portfolio-asset-class.d.ts +31 -31
  133. package/dist/models/model-portfolio-asset-class.js +14 -14
  134. package/dist/models/model-portfolio-details.d.ts +39 -39
  135. package/dist/models/model-portfolio-details.js +14 -14
  136. package/dist/models/model-portfolio-security.d.ts +31 -31
  137. package/dist/models/model-portfolio-security.js +14 -14
  138. package/dist/models/model-portfolio.d.ts +38 -38
  139. package/dist/models/model-portfolio.js +14 -14
  140. package/dist/models/model400-failed-request-response.d.ts +30 -30
  141. package/dist/models/model400-failed-request-response.js +14 -14
  142. package/dist/models/model401-failed-request-response.d.ts +30 -30
  143. package/dist/models/model401-failed-request-response.js +14 -14
  144. package/dist/models/model403-failed-request-response.d.ts +30 -30
  145. package/dist/models/model403-failed-request-response.js +14 -14
  146. package/dist/models/model404-failed-request-response.d.ts +30 -30
  147. package/dist/models/model404-failed-request-response.js +14 -14
  148. package/dist/models/monthly-dividends.d.ts +31 -31
  149. package/dist/models/monthly-dividends.js +14 -14
  150. package/dist/models/net-contributions.d.ts +36 -36
  151. package/dist/models/net-contributions.js +14 -14
  152. package/dist/models/net-dividend.d.ts +37 -37
  153. package/dist/models/net-dividend.js +14 -14
  154. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +36 -36
  155. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +14 -14
  156. package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +37 -37
  157. package/dist/models/option-chain-inner-chain-per-root-inner.js +14 -14
  158. package/dist/models/option-chain-inner.d.ts +49 -49
  159. package/dist/models/option-chain-inner.js +14 -14
  160. package/dist/models/option-leg.d.ts +38 -38
  161. package/dist/models/option-leg.js +14 -14
  162. package/dist/models/option-strategy-legs-inner.d.ts +41 -41
  163. package/dist/models/option-strategy-legs-inner.js +14 -14
  164. package/dist/models/option-strategy.d.ts +50 -50
  165. package/dist/models/option-strategy.js +14 -14
  166. package/dist/models/options-get-option-strategy-request.d.ts +38 -38
  167. package/dist/models/options-get-option-strategy-request.js +14 -14
  168. package/dist/models/options-holdings.d.ts +56 -56
  169. package/dist/models/options-holdings.js +14 -14
  170. package/dist/models/options-place-option-strategy-request.d.ts +38 -38
  171. package/dist/models/options-place-option-strategy-request.js +14 -14
  172. package/dist/models/options-position.d.ts +62 -62
  173. package/dist/models/options-position.js +14 -14
  174. package/dist/models/options-symbol.d.ts +85 -85
  175. package/dist/models/options-symbol.js +14 -14
  176. package/dist/models/order-type.d.ts +16 -16
  177. package/dist/models/order-type.js +14 -14
  178. package/dist/models/partner-data.d.ts +91 -91
  179. package/dist/models/partner-data.js +14 -14
  180. package/dist/models/past-value.d.ts +36 -36
  181. package/dist/models/past-value.js +14 -14
  182. package/dist/models/performance-custom.d.ts +137 -137
  183. package/dist/models/performance-custom.js +14 -14
  184. package/dist/models/portfolio-group-info.d.ts +92 -92
  185. package/dist/models/portfolio-group-info.js +14 -14
  186. package/dist/models/portfolio-group-position.d.ts +37 -37
  187. package/dist/models/portfolio-group-position.js +14 -14
  188. package/dist/models/portfolio-group-settings.d.ts +49 -49
  189. package/dist/models/portfolio-group-settings.js +14 -14
  190. package/dist/models/portfolio-group.d.ts +30 -30
  191. package/dist/models/portfolio-group.js +14 -14
  192. package/dist/models/position-symbol.d.ts +55 -55
  193. package/dist/models/position-symbol.js +14 -14
  194. package/dist/models/position.d.ts +55 -55
  195. package/dist/models/position.js +14 -14
  196. package/dist/models/redirect-tokenand-pin.d.ts +30 -30
  197. package/dist/models/redirect-tokenand-pin.js +14 -14
  198. package/dist/models/security-type.d.ts +42 -42
  199. package/dist/models/security-type.js +14 -14
  200. package/dist/models/session-event.d.ts +62 -62
  201. package/dist/models/session-event.js +14 -14
  202. package/dist/models/snap-trade-apidisclaimer-accept-status.d.ts +30 -30
  203. package/dist/models/snap-trade-apidisclaimer-accept-status.js +14 -14
  204. package/dist/models/snap-trade-holdings-account-account-id.d.ts +75 -75
  205. package/dist/models/snap-trade-holdings-account-account-id.js +14 -14
  206. package/dist/models/snap-trade-holdings-account.d.ts +70 -70
  207. package/dist/models/snap-trade-holdings-account.js +14 -14
  208. package/dist/models/snap-trade-holdings-total-value.d.ts +30 -30
  209. package/dist/models/snap-trade-holdings-total-value.js +14 -14
  210. package/dist/models/snap-trade-login-user-request-body.d.ts +49 -49
  211. package/dist/models/snap-trade-login-user-request-body.js +14 -14
  212. package/dist/models/snap-trade-register-user-request-body.d.ts +29 -29
  213. package/dist/models/snap-trade-register-user-request-body.js +14 -14
  214. package/dist/models/status.d.ts +36 -36
  215. package/dist/models/status.js +14 -14
  216. package/dist/models/strategy-impact-legs-inner.d.ts +60 -60
  217. package/dist/models/strategy-impact-legs-inner.js +14 -14
  218. package/dist/models/strategy-impact.d.ts +85 -85
  219. package/dist/models/strategy-impact.js +14 -14
  220. package/dist/models/strategy-order-place-orders-inner-legs-inner.d.ts +60 -60
  221. package/dist/models/strategy-order-place-orders-inner-legs-inner.js +14 -14
  222. package/dist/models/strategy-order-place-orders-inner.d.ts +277 -277
  223. package/dist/models/strategy-order-place-orders-inner.js +14 -14
  224. package/dist/models/strategy-order-place.d.ts +31 -31
  225. package/dist/models/strategy-order-place.js +14 -14
  226. package/dist/models/strategy-order-record.d.ts +89 -89
  227. package/dist/models/strategy-order-record.js +14 -14
  228. package/dist/models/strategy-quotes-greek.d.ts +48 -48
  229. package/dist/models/strategy-quotes-greek.js +14 -14
  230. package/dist/models/strategy-quotes.d.ts +56 -56
  231. package/dist/models/strategy-quotes.js +14 -14
  232. package/dist/models/sub-period-return-rate.d.ts +36 -36
  233. package/dist/models/sub-period-return-rate.js +14 -14
  234. package/dist/models/symbol-query.d.ts +23 -23
  235. package/dist/models/symbol-query.js +14 -14
  236. package/dist/models/symbol.d.ts +63 -63
  237. package/dist/models/symbol.js +14 -14
  238. package/dist/models/symbols-quotes-inner.d.ts +54 -54
  239. package/dist/models/symbols-quotes-inner.js +14 -14
  240. package/dist/models/target-asset.d.ts +57 -57
  241. package/dist/models/target-asset.js +14 -14
  242. package/dist/models/time-in-force.d.ts +16 -16
  243. package/dist/models/time-in-force.js +14 -14
  244. package/dist/models/trade-execution-status.d.ts +80 -80
  245. package/dist/models/trade-execution-status.js +14 -14
  246. package/dist/models/trade-impact.d.ts +50 -50
  247. package/dist/models/trade-impact.js +14 -14
  248. package/dist/models/trade.d.ts +71 -71
  249. package/dist/models/trade.js +14 -14
  250. package/dist/models/trading-cancel-user-account-order-request.d.ts +23 -23
  251. package/dist/models/trading-cancel-user-account-order-request.js +14 -14
  252. package/dist/models/trading-place-ocoorder-request.d.ts +29 -29
  253. package/dist/models/trading-place-ocoorder-request.js +14 -14
  254. package/dist/models/transactions-status.d.ts +29 -29
  255. package/dist/models/transactions-status.js +14 -14
  256. package/dist/models/underlying-symbol.d.ts +63 -63
  257. package/dist/models/underlying-symbol.js +14 -14
  258. package/dist/models/universal-activity.d.ts +118 -118
  259. package/dist/models/universal-activity.js +14 -14
  260. package/dist/models/universal-symbol-ticker.d.ts +69 -69
  261. package/dist/models/universal-symbol-ticker.js +14 -14
  262. package/dist/models/universal-symbol.d.ts +69 -69
  263. package/dist/models/universal-symbol.js +14 -14
  264. package/dist/models/user-error-log.d.ts +54 -54
  265. package/dist/models/user-error-log.js +14 -14
  266. package/dist/models/user-idand-secret.d.ts +30 -30
  267. package/dist/models/user-idand-secret.js +14 -14
  268. package/dist/models/user-settings.d.ts +79 -79
  269. package/dist/models/user-settings.js +14 -14
  270. package/dist/models/usexchange.d.ts +72 -72
  271. package/dist/models/usexchange.js +14 -14
  272. package/dist/pagination/page-types.d.ts +26 -26
  273. package/dist/pagination/page-types.js +12 -12
  274. package/dist/pagination/page.d.ts +35 -35
  275. package/dist/pagination/page.js +60 -60
  276. package/dist/pagination/pageable.d.ts +57 -57
  277. package/dist/pagination/pageable.js +126 -126
  278. package/dist/pagination/paginate.d.ts +16 -16
  279. package/dist/pagination/paginate.js +77 -77
  280. package/dist/requestAfterHook.d.ts +8 -8
  281. package/dist/requestAfterHook.js +45 -45
  282. package/dist/requestBeforeHook.d.ts +9 -9
  283. package/dist/requestBeforeHook.js +8 -8
  284. package/package.json +42 -42
@@ -1,36 +1,36 @@
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
+ * 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,14 +1,14 @@
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
+ /* 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,137 +1,137 @@
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
+ /**
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,14 +1,14 @@
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
+ /* 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,92 +1,92 @@
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
+ /**
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,14 +1,14 @@
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
+ /* 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 });