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,4 +1,4 @@
1
- import { TradingApiGenerated } from "./trading-api-generated";
2
- export * from "./trading-api-generated";
3
- export declare class TradingApi extends TradingApiGenerated {
4
- }
1
+ import { TradingApiGenerated } from "./trading-api-generated";
2
+ export * from "./trading-api-generated";
3
+ export declare class TradingApi extends TradingApiGenerated {
4
+ }
@@ -1,22 +1,22 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- exports.TradingApi = void 0;
18
- const trading_api_generated_1 = require("./trading-api-generated");
19
- __exportStar(require("./trading-api-generated"), exports);
20
- class TradingApi extends trading_api_generated_1.TradingApiGenerated {
21
- }
22
- exports.TradingApi = TradingApi;
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ exports.TradingApi = void 0;
18
+ const trading_api_generated_1 = require("./trading-api-generated");
19
+ __exportStar(require("./trading-api-generated"), exports);
20
+ class TradingApi extends trading_api_generated_1.TradingApiGenerated {
21
+ }
22
+ exports.TradingApi = TradingApi;
@@ -1,217 +1,207 @@
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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
- import { Configuration } from '../configuration';
13
- import { RequestArgs, BaseAPI } from '../base';
14
- import { PerformanceCustom } from '../models';
15
- import { UniversalActivity } from '../models';
16
- /**
17
- * TransactionsAndReportingApi - axios parameter creator
18
- * @export
19
- */
20
- export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
21
- /**
22
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
23
- * @summary Get transaction history for a user
24
- * @param {string} userId
25
- * @param {string} userSecret
26
- * @param {string | Date} [startDate]
27
- * @param {string | Date} [endDate]
28
- * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
29
- * @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
30
- * @param {string} [type] Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
31
- * @param {*} [options] Override http request option.
32
- * @throws {RequiredError}
33
- */
34
- getActivities: (userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
- /**
36
- * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
37
- * @summary Get performance information for a specific timeframe
38
- * @param {string | Date} startDate
39
- * @param {string | Date} endDate
40
- * @param {string} userId
41
- * @param {string} userSecret
42
- * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
43
- * @param {boolean} [detailed] Optional, increases frequency of data points for the total value and contribution charts if set to true
44
- * @param {string} [frequency] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
45
- * @param {*} [options] Override http request option.
46
- * @throws {RequiredError}
47
- */
48
- getReportingCustomRange: (startDate: string | Date, endDate: string | Date, userId: string, userSecret: string, accounts?: string, detailed?: boolean, frequency?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
- };
50
- /**
51
- * TransactionsAndReportingApi - functional programming interface
52
- * @export
53
- */
54
- export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
55
- /**
56
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
57
- * @summary Get transaction history for a user
58
- * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
59
- * @param {*} [options] Override http request option.
60
- * @throws {RequiredError}
61
- */
62
- getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
63
- /**
64
- * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
65
- * @summary Get performance information for a specific timeframe
66
- * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
67
- * @param {*} [options] Override http request option.
68
- * @throws {RequiredError}
69
- */
70
- getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PerformanceCustom>>;
71
- };
72
- /**
73
- * TransactionsAndReportingApi - factory interface
74
- * @export
75
- */
76
- export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
77
- /**
78
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
79
- * @summary Get transaction history for a user
80
- * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
81
- * @param {*} [options] Override http request option.
82
- * @throws {RequiredError}
83
- */
84
- getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
85
- /**
86
- * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
87
- * @summary Get performance information for a specific timeframe
88
- * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
89
- * @param {*} [options] Override http request option.
90
- * @throws {RequiredError}
91
- */
92
- getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): AxiosPromise<PerformanceCustom>;
93
- };
94
- /**
95
- * Request parameters for getActivities operation in TransactionsAndReportingApi.
96
- * @export
97
- * @interface TransactionsAndReportingApiGetActivitiesRequest
98
- */
99
- export type TransactionsAndReportingApiGetActivitiesRequest = {
100
- /**
101
- *
102
- * @type {string}
103
- * @memberof TransactionsAndReportingApiGetActivities
104
- */
105
- readonly userId: string;
106
- /**
107
- *
108
- * @type {string}
109
- * @memberof TransactionsAndReportingApiGetActivities
110
- */
111
- readonly userSecret: string;
112
- /**
113
- *
114
- * @type {string | Date}
115
- * @memberof TransactionsAndReportingApiGetActivities
116
- */
117
- readonly startDate?: string | Date;
118
- /**
119
- *
120
- * @type {string | Date}
121
- * @memberof TransactionsAndReportingApiGetActivities
122
- */
123
- readonly endDate?: string | Date;
124
- /**
125
- * Optional comma seperated list of account IDs used to filter the request on specific accounts
126
- * @type {string}
127
- * @memberof TransactionsAndReportingApiGetActivities
128
- */
129
- readonly accounts?: string;
130
- /**
131
- * Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
132
- * @type {string}
133
- * @memberof TransactionsAndReportingApiGetActivities
134
- */
135
- readonly brokerageAuthorizations?: string;
136
- /**
137
- * Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
138
- * @type {string}
139
- * @memberof TransactionsAndReportingApiGetActivities
140
- */
141
- readonly type?: string;
142
- };
143
- /**
144
- * Request parameters for getReportingCustomRange operation in TransactionsAndReportingApi.
145
- * @export
146
- * @interface TransactionsAndReportingApiGetReportingCustomRangeRequest
147
- */
148
- export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
149
- /**
150
- *
151
- * @type {string | Date}
152
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
153
- */
154
- readonly startDate: string | Date;
155
- /**
156
- *
157
- * @type {string | Date}
158
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
159
- */
160
- readonly endDate: string | Date;
161
- /**
162
- *
163
- * @type {string}
164
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
165
- */
166
- readonly userId: string;
167
- /**
168
- *
169
- * @type {string}
170
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
171
- */
172
- readonly userSecret: string;
173
- /**
174
- * Optional comma seperated list of account IDs used to filter the request on specific accounts
175
- * @type {string}
176
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
177
- */
178
- readonly accounts?: string;
179
- /**
180
- * Optional, increases frequency of data points for the total value and contribution charts if set to true
181
- * @type {boolean}
182
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
183
- */
184
- readonly detailed?: boolean;
185
- /**
186
- * Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
187
- * @type {string}
188
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
189
- */
190
- readonly frequency?: string;
191
- };
192
- /**
193
- * TransactionsAndReportingApiGenerated - object-oriented interface
194
- * @export
195
- * @class TransactionsAndReportingApiGenerated
196
- * @extends {BaseAPI}
197
- */
198
- export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
199
- /**
200
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
201
- * @summary Get transaction history for a user
202
- * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
203
- * @param {*} [options] Override http request option.
204
- * @throws {RequiredError}
205
- * @memberof TransactionsAndReportingApiGenerated
206
- */
207
- getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any>>;
208
- /**
209
- * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
210
- * @summary Get performance information for a specific timeframe
211
- * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
212
- * @param {*} [options] Override http request option.
213
- * @throws {RequiredError}
214
- * @memberof TransactionsAndReportingApiGenerated
215
- */
216
- getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PerformanceCustom, any>>;
217
- }
1
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
2
+ import { Configuration } from '../configuration';
3
+ import { RequestArgs, BaseAPI } from '../base';
4
+ import { PerformanceCustom } from '../models';
5
+ import { UniversalActivity } from '../models';
6
+ /**
7
+ * TransactionsAndReportingApi - axios parameter creator
8
+ * @export
9
+ */
10
+ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
11
+ /**
12
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
13
+ * @summary Get transaction history for a user
14
+ * @param {string} userId
15
+ * @param {string} userSecret
16
+ * @param {string | Date} [startDate]
17
+ * @param {string | Date} [endDate]
18
+ * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
19
+ * @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
20
+ * @param {string} [type] Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
21
+ * @param {*} [options] Override http request option.
22
+ * @throws {RequiredError}
23
+ */
24
+ getActivities: (userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
25
+ /**
26
+ * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
27
+ * @summary Get performance information for a specific timeframe
28
+ * @param {string | Date} startDate
29
+ * @param {string | Date} endDate
30
+ * @param {string} userId
31
+ * @param {string} userSecret
32
+ * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
33
+ * @param {boolean} [detailed] Optional, increases frequency of data points for the total value and contribution charts if set to true
34
+ * @param {string} [frequency] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ getReportingCustomRange: (startDate: string | Date, endDate: string | Date, userId: string, userSecret: string, accounts?: string, detailed?: boolean, frequency?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39
+ };
40
+ /**
41
+ * TransactionsAndReportingApi - functional programming interface
42
+ * @export
43
+ */
44
+ export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
45
+ /**
46
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
47
+ * @summary Get transaction history for a user
48
+ * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
53
+ /**
54
+ * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
55
+ * @summary Get performance information for a specific timeframe
56
+ * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
57
+ * @param {*} [options] Override http request option.
58
+ * @throws {RequiredError}
59
+ */
60
+ getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PerformanceCustom>>;
61
+ };
62
+ /**
63
+ * TransactionsAndReportingApi - factory interface
64
+ * @export
65
+ */
66
+ export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
67
+ /**
68
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
69
+ * @summary Get transaction history for a user
70
+ * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
71
+ * @param {*} [options] Override http request option.
72
+ * @throws {RequiredError}
73
+ */
74
+ getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
75
+ /**
76
+ * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
77
+ * @summary Get performance information for a specific timeframe
78
+ * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
79
+ * @param {*} [options] Override http request option.
80
+ * @throws {RequiredError}
81
+ */
82
+ getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): AxiosPromise<PerformanceCustom>;
83
+ };
84
+ /**
85
+ * Request parameters for getActivities operation in TransactionsAndReportingApi.
86
+ * @export
87
+ * @interface TransactionsAndReportingApiGetActivitiesRequest
88
+ */
89
+ export type TransactionsAndReportingApiGetActivitiesRequest = {
90
+ /**
91
+ *
92
+ * @type {string}
93
+ * @memberof TransactionsAndReportingApiGetActivities
94
+ */
95
+ readonly userId: string;
96
+ /**
97
+ *
98
+ * @type {string}
99
+ * @memberof TransactionsAndReportingApiGetActivities
100
+ */
101
+ readonly userSecret: string;
102
+ /**
103
+ *
104
+ * @type {string | Date}
105
+ * @memberof TransactionsAndReportingApiGetActivities
106
+ */
107
+ readonly startDate?: string | Date;
108
+ /**
109
+ *
110
+ * @type {string | Date}
111
+ * @memberof TransactionsAndReportingApiGetActivities
112
+ */
113
+ readonly endDate?: string | Date;
114
+ /**
115
+ * Optional comma seperated list of account IDs used to filter the request on specific accounts
116
+ * @type {string}
117
+ * @memberof TransactionsAndReportingApiGetActivities
118
+ */
119
+ readonly accounts?: string;
120
+ /**
121
+ * Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
122
+ * @type {string}
123
+ * @memberof TransactionsAndReportingApiGetActivities
124
+ */
125
+ readonly brokerageAuthorizations?: string;
126
+ /**
127
+ * Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
128
+ * @type {string}
129
+ * @memberof TransactionsAndReportingApiGetActivities
130
+ */
131
+ readonly type?: string;
132
+ };
133
+ /**
134
+ * Request parameters for getReportingCustomRange operation in TransactionsAndReportingApi.
135
+ * @export
136
+ * @interface TransactionsAndReportingApiGetReportingCustomRangeRequest
137
+ */
138
+ export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
139
+ /**
140
+ *
141
+ * @type {string | Date}
142
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
143
+ */
144
+ readonly startDate: string | Date;
145
+ /**
146
+ *
147
+ * @type {string | Date}
148
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
149
+ */
150
+ readonly endDate: string | Date;
151
+ /**
152
+ *
153
+ * @type {string}
154
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
155
+ */
156
+ readonly userId: string;
157
+ /**
158
+ *
159
+ * @type {string}
160
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
161
+ */
162
+ readonly userSecret: string;
163
+ /**
164
+ * Optional comma seperated list of account IDs used to filter the request on specific accounts
165
+ * @type {string}
166
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
167
+ */
168
+ readonly accounts?: string;
169
+ /**
170
+ * Optional, increases frequency of data points for the total value and contribution charts if set to true
171
+ * @type {boolean}
172
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
173
+ */
174
+ readonly detailed?: boolean;
175
+ /**
176
+ * Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
177
+ * @type {string}
178
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
179
+ */
180
+ readonly frequency?: string;
181
+ };
182
+ /**
183
+ * TransactionsAndReportingApiGenerated - object-oriented interface
184
+ * @export
185
+ * @class TransactionsAndReportingApiGenerated
186
+ * @extends {BaseAPI}
187
+ */
188
+ export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
189
+ /**
190
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
191
+ * @summary Get transaction history for a user
192
+ * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
193
+ * @param {*} [options] Override http request option.
194
+ * @throws {RequiredError}
195
+ * @memberof TransactionsAndReportingApiGenerated
196
+ */
197
+ getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any>>;
198
+ /**
199
+ * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
200
+ * @summary Get performance information for a specific timeframe
201
+ * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
202
+ * @param {*} [options] Override http request option.
203
+ * @throws {RequiredError}
204
+ * @memberof TransactionsAndReportingApiGenerated
205
+ */
206
+ getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PerformanceCustom, any>>;
207
+ }