snaptrade-typescript-sdk 8.17.0 → 8.18.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 (288) hide show
  1. package/README.md +147 -183
  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 -527
  5. package/dist/api/account-information-api.js +1049 -1050
  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 -71
  9. package/dist/api/api-status-api.js +203 -204
  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 -268
  13. package/dist/api/authentication-api.js +661 -662
  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 -276
  17. package/dist/api/connections-api.js +583 -584
  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 -95
  21. package/dist/api/error-logs-api.js +240 -241
  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 -370
  25. package/dist/api/options-api.js +730 -731
  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 -469
  29. package/dist/api/reference-data-api.js +1246 -1247
  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 -634
  33. package/dist/api/trading-api.js +841 -1282
  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 -219
  37. package/dist/api/transactions-and-reporting-api.js +403 -404
  38. package/dist/api.d.ts +19 -21
  39. package/dist/api.js +37 -39
  40. package/dist/base.d.ts +54 -55
  41. package/dist/base.js +81 -82
  42. package/dist/client-custom.d.ts +4 -4
  43. package/dist/client-custom.js +9 -9
  44. package/dist/client.d.ts +25 -27
  45. package/dist/client.js +50 -52
  46. package/dist/common.d.ts +67 -67
  47. package/dist/common.js +236 -233
  48. package/dist/configuration.d.ts +99 -100
  49. package/dist/configuration.js +55 -56
  50. package/dist/index.d.ts +14 -15
  51. package/dist/index.js +32 -33
  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 -54
  55. package/dist/models/account-holdings-account.js +14 -15
  56. package/dist/models/account-holdings.d.ts +46 -47
  57. package/dist/models/account-holdings.js +14 -15
  58. package/dist/models/account-order-record-status.d.ts +16 -17
  59. package/dist/models/account-order-record-status.js +14 -15
  60. package/dist/models/account-order-record.d.ts +132 -133
  61. package/dist/models/account-order-record.js +14 -15
  62. package/dist/models/account-simple.d.ts +43 -44
  63. package/dist/models/account-simple.js +14 -15
  64. package/dist/models/account-sync-status.d.ts +24 -25
  65. package/dist/models/account-sync-status.js +14 -15
  66. package/dist/models/account.d.ts +82 -83
  67. package/dist/models/account.js +14 -15
  68. package/dist/models/action.d.ts +16 -17
  69. package/dist/models/action.js +14 -15
  70. package/dist/models/authentication-login-snap-trade-user200-response.d.ts +17 -18
  71. package/dist/models/authentication-login-snap-trade-user200-response.js +14 -15
  72. package/dist/models/balance.d.ts +31 -32
  73. package/dist/models/balance.js +14 -15
  74. package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +36 -37
  75. package/dist/models/brokerage-authorization-type-read-only-brokerage.js +14 -15
  76. package/dist/models/brokerage-authorization-type-read-only.d.ts +46 -47
  77. package/dist/models/brokerage-authorization-type-read-only.js +14 -15
  78. package/dist/models/brokerage-authorization-type.d.ts +26 -27
  79. package/dist/models/brokerage-authorization-type.js +14 -15
  80. package/dist/models/brokerage-authorization.d.ts +75 -76
  81. package/dist/models/brokerage-authorization.js +14 -15
  82. package/dist/models/brokerage-symbol.d.ts +50 -51
  83. package/dist/models/brokerage-symbol.js +14 -15
  84. package/dist/models/brokerage-type.d.ts +30 -31
  85. package/dist/models/brokerage-type.js +14 -15
  86. package/dist/models/brokerage.d.ts +127 -128
  87. package/dist/models/brokerage.js +14 -15
  88. package/dist/models/calculated-trade.d.ts +31 -32
  89. package/dist/models/calculated-trade.js +14 -15
  90. package/dist/models/cash-restriction.d.ts +50 -51
  91. package/dist/models/cash-restriction.js +14 -15
  92. package/dist/models/connections-session-events200-response-inner.d.ts +16 -17
  93. package/dist/models/connections-session-events200-response-inner.js +14 -15
  94. package/dist/models/currency.d.ts +36 -37
  95. package/dist/models/currency.js +14 -15
  96. package/dist/models/delete-user-response.d.ts +30 -31
  97. package/dist/models/delete-user-response.js +14 -15
  98. package/dist/models/dividend-at-date.d.ts +36 -37
  99. package/dist/models/dividend-at-date.js +14 -15
  100. package/dist/models/encrypted-response-encrypted-message-data.d.ts +36 -37
  101. package/dist/models/encrypted-response-encrypted-message-data.js +14 -15
  102. package/dist/models/encrypted-response.d.ts +30 -31
  103. package/dist/models/encrypted-response.js +14 -15
  104. package/dist/models/exchange-rate-pairs.d.ts +37 -38
  105. package/dist/models/exchange-rate-pairs.js +14 -15
  106. package/dist/models/exchange.d.ts +66 -67
  107. package/dist/models/exchange.js +14 -15
  108. package/dist/models/excluded-asset.d.ts +25 -26
  109. package/dist/models/excluded-asset.js +14 -15
  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 -25
  113. package/dist/models/jwt.js +14 -15
  114. package/dist/models/login-redirect-uri.d.ts +29 -30
  115. package/dist/models/login-redirect-uri.js +14 -15
  116. package/dist/models/manual-trade-and-impact.d.ts +38 -39
  117. package/dist/models/manual-trade-and-impact.js +14 -15
  118. package/dist/models/manual-trade-balance.d.ts +38 -39
  119. package/dist/models/manual-trade-balance.js +14 -15
  120. package/dist/models/manual-trade-form.d.ts +68 -69
  121. package/dist/models/manual-trade-form.js +14 -15
  122. package/dist/models/manual-trade-symbol.d.ts +55 -56
  123. package/dist/models/manual-trade-symbol.js +14 -15
  124. package/dist/models/manual-trade.d.ts +70 -71
  125. package/dist/models/manual-trade.js +14 -15
  126. package/dist/models/model-asset-class-details.d.ts +32 -32
  127. package/dist/models/model-asset-class-details.js +14 -15
  128. package/dist/models/model-asset-class-target.d.ts +25 -26
  129. package/dist/models/model-asset-class-target.js +14 -15
  130. package/dist/models/model-asset-class.d.ts +30 -31
  131. package/dist/models/model-asset-class.js +14 -15
  132. package/dist/models/model-portfolio-asset-class.d.ts +31 -32
  133. package/dist/models/model-portfolio-asset-class.js +14 -15
  134. package/dist/models/model-portfolio-details.d.ts +39 -39
  135. package/dist/models/model-portfolio-details.js +14 -15
  136. package/dist/models/model-portfolio-security.d.ts +31 -32
  137. package/dist/models/model-portfolio-security.js +14 -15
  138. package/dist/models/model-portfolio.d.ts +38 -39
  139. package/dist/models/model-portfolio.js +14 -15
  140. package/dist/models/model400-failed-request-response.d.ts +30 -31
  141. package/dist/models/model400-failed-request-response.js +14 -15
  142. package/dist/models/model401-failed-request-response.d.ts +30 -31
  143. package/dist/models/model401-failed-request-response.js +14 -15
  144. package/dist/models/model403-failed-request-response.d.ts +30 -31
  145. package/dist/models/model403-failed-request-response.js +14 -15
  146. package/dist/models/model404-failed-request-response.d.ts +30 -31
  147. package/dist/models/model404-failed-request-response.js +14 -15
  148. package/dist/models/monthly-dividends.d.ts +31 -32
  149. package/dist/models/monthly-dividends.js +14 -15
  150. package/dist/models/net-contributions.d.ts +36 -37
  151. package/dist/models/net-contributions.js +14 -15
  152. package/dist/models/net-dividend.d.ts +37 -38
  153. package/dist/models/net-dividend.js +14 -15
  154. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +36 -37
  155. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +14 -15
  156. package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +37 -38
  157. package/dist/models/option-chain-inner-chain-per-root-inner.js +14 -15
  158. package/dist/models/option-chain-inner.d.ts +49 -50
  159. package/dist/models/option-chain-inner.js +14 -15
  160. package/dist/models/option-leg.d.ts +38 -39
  161. package/dist/models/option-leg.js +14 -15
  162. package/dist/models/option-strategy-legs-inner.d.ts +41 -42
  163. package/dist/models/option-strategy-legs-inner.js +14 -15
  164. package/dist/models/option-strategy.d.ts +50 -51
  165. package/dist/models/option-strategy.js +14 -15
  166. package/dist/models/options-get-option-strategy-request.d.ts +38 -39
  167. package/dist/models/options-get-option-strategy-request.js +14 -15
  168. package/dist/models/options-holdings.d.ts +56 -57
  169. package/dist/models/options-holdings.js +14 -15
  170. package/dist/models/options-place-option-strategy-request.d.ts +38 -39
  171. package/dist/models/options-place-option-strategy-request.js +14 -15
  172. package/dist/models/options-position.d.ts +62 -63
  173. package/dist/models/options-position.js +14 -15
  174. package/dist/models/options-symbol.d.ts +85 -86
  175. package/dist/models/options-symbol.js +14 -15
  176. package/dist/models/order-type.d.ts +16 -17
  177. package/dist/models/order-type.js +14 -15
  178. package/dist/models/partner-data.d.ts +91 -92
  179. package/dist/models/partner-data.js +14 -15
  180. package/dist/models/past-value.d.ts +36 -37
  181. package/dist/models/past-value.js +14 -15
  182. package/dist/models/performance-custom.d.ts +137 -138
  183. package/dist/models/performance-custom.js +14 -15
  184. package/dist/models/portfolio-group-info.d.ts +92 -93
  185. package/dist/models/portfolio-group-info.js +14 -15
  186. package/dist/models/portfolio-group-position.d.ts +37 -38
  187. package/dist/models/portfolio-group-position.js +14 -15
  188. package/dist/models/portfolio-group-settings.d.ts +49 -50
  189. package/dist/models/portfolio-group-settings.js +14 -15
  190. package/dist/models/portfolio-group.d.ts +30 -31
  191. package/dist/models/portfolio-group.js +14 -15
  192. package/dist/models/position-symbol.d.ts +55 -56
  193. package/dist/models/position-symbol.js +14 -15
  194. package/dist/models/position.d.ts +55 -56
  195. package/dist/models/position.js +14 -15
  196. package/dist/models/redirect-tokenand-pin.d.ts +30 -31
  197. package/dist/models/redirect-tokenand-pin.js +14 -15
  198. package/dist/models/security-type.d.ts +42 -43
  199. package/dist/models/security-type.js +14 -15
  200. package/dist/models/session-event.d.ts +62 -63
  201. package/dist/models/session-event.js +14 -15
  202. package/dist/models/snap-trade-apidisclaimer-accept-status.d.ts +30 -31
  203. package/dist/models/snap-trade-apidisclaimer-accept-status.js +14 -15
  204. package/dist/models/snap-trade-holdings-account-account-id.d.ts +75 -76
  205. package/dist/models/snap-trade-holdings-account-account-id.js +14 -15
  206. package/dist/models/snap-trade-holdings-account.d.ts +70 -71
  207. package/dist/models/snap-trade-holdings-account.js +14 -15
  208. package/dist/models/snap-trade-holdings-total-value.d.ts +30 -31
  209. package/dist/models/snap-trade-holdings-total-value.js +14 -15
  210. package/dist/models/snap-trade-login-user-request-body.d.ts +49 -50
  211. package/dist/models/snap-trade-login-user-request-body.js +14 -15
  212. package/dist/models/snap-trade-register-user-request-body.d.ts +29 -30
  213. package/dist/models/snap-trade-register-user-request-body.js +14 -15
  214. package/dist/models/status.d.ts +36 -37
  215. package/dist/models/status.js +14 -15
  216. package/dist/models/strategy-impact-legs-inner.d.ts +60 -61
  217. package/dist/models/strategy-impact-legs-inner.js +14 -15
  218. package/dist/models/strategy-impact.d.ts +85 -86
  219. package/dist/models/strategy-impact.js +14 -15
  220. package/dist/models/strategy-order-place-orders-inner-legs-inner.d.ts +60 -61
  221. package/dist/models/strategy-order-place-orders-inner-legs-inner.js +14 -15
  222. package/dist/models/strategy-order-place-orders-inner.d.ts +277 -278
  223. package/dist/models/strategy-order-place-orders-inner.js +14 -15
  224. package/dist/models/strategy-order-place.d.ts +31 -32
  225. package/dist/models/strategy-order-place.js +14 -15
  226. package/dist/models/strategy-order-record.d.ts +89 -90
  227. package/dist/models/strategy-order-record.js +14 -15
  228. package/dist/models/strategy-quotes-greek.d.ts +48 -49
  229. package/dist/models/strategy-quotes-greek.js +14 -15
  230. package/dist/models/strategy-quotes.d.ts +56 -57
  231. package/dist/models/strategy-quotes.js +14 -15
  232. package/dist/models/sub-period-return-rate.d.ts +36 -37
  233. package/dist/models/sub-period-return-rate.js +14 -15
  234. package/dist/models/symbol-query.d.ts +23 -24
  235. package/dist/models/symbol-query.js +14 -15
  236. package/dist/models/symbol.d.ts +63 -64
  237. package/dist/models/symbol.js +14 -15
  238. package/dist/models/symbols-quotes-inner.d.ts +54 -55
  239. package/dist/models/symbols-quotes-inner.js +14 -15
  240. package/dist/models/target-asset.d.ts +57 -57
  241. package/dist/models/target-asset.js +14 -15
  242. package/dist/models/time-in-force.d.ts +16 -17
  243. package/dist/models/time-in-force.js +14 -15
  244. package/dist/models/trade-execution-status.d.ts +80 -81
  245. package/dist/models/trade-execution-status.js +14 -15
  246. package/dist/models/trade-impact.d.ts +50 -51
  247. package/dist/models/trade-impact.js +14 -15
  248. package/dist/models/trade.d.ts +71 -71
  249. package/dist/models/trade.js +14 -15
  250. package/dist/models/trading-cancel-user-account-order-request.d.ts +23 -24
  251. package/dist/models/trading-cancel-user-account-order-request.js +14 -15
  252. package/dist/models/trading-place-ocoorder-request.d.ts +29 -30
  253. package/dist/models/trading-place-ocoorder-request.js +14 -15
  254. package/dist/models/transactions-status.d.ts +29 -30
  255. package/dist/models/transactions-status.js +14 -15
  256. package/dist/models/underlying-symbol.d.ts +63 -64
  257. package/dist/models/underlying-symbol.js +14 -15
  258. package/dist/models/universal-activity.d.ts +118 -119
  259. package/dist/models/universal-activity.js +14 -15
  260. package/dist/models/universal-symbol-ticker.d.ts +69 -70
  261. package/dist/models/universal-symbol-ticker.js +14 -15
  262. package/dist/models/universal-symbol.d.ts +69 -69
  263. package/dist/models/universal-symbol.js +14 -15
  264. package/dist/models/user-error-log.d.ts +54 -55
  265. package/dist/models/user-error-log.js +14 -15
  266. package/dist/models/user-idand-secret.d.ts +30 -31
  267. package/dist/models/user-idand-secret.js +14 -15
  268. package/dist/models/user-settings.d.ts +79 -80
  269. package/dist/models/user-settings.js +14 -15
  270. package/dist/models/usexchange.d.ts +72 -73
  271. package/dist/models/usexchange.js +14 -15
  272. package/dist/pagination/page-types.d.ts +26 -27
  273. package/dist/pagination/page-types.js +12 -13
  274. package/dist/pagination/page.d.ts +35 -36
  275. package/dist/pagination/page.js +60 -61
  276. package/dist/pagination/pageable.d.ts +57 -58
  277. package/dist/pagination/pageable.js +126 -127
  278. package/dist/pagination/paginate.d.ts +16 -17
  279. package/dist/pagination/paginate.js +77 -78
  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
  285. package/dist/api/portfolio-management-api-custom.d.ts +0 -3
  286. package/dist/api/portfolio-management-api-custom.js +0 -27
  287. package/dist/api/portfolio-management-api.d.ts +0 -1612
  288. package/dist/api/portfolio-management-api.js +0 -3534
@@ -1,3 +1,3 @@
1
- import { BaseAPI } from "../base";
2
- export declare class TransactionsAndReportingApiCustom extends BaseAPI {
3
- }
1
+ import { BaseAPI } from "../base";
2
+ export declare class TransactionsAndReportingApiCustom extends BaseAPI {
3
+ }
@@ -1,27 +1,27 @@
1
- "use strict";
2
- var __extends = (this && this.__extends) || (function () {
3
- var extendStatics = function (d, b) {
4
- extendStatics = Object.setPrototypeOf ||
5
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
6
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
7
- return extendStatics(d, b);
8
- };
9
- return function (d, b) {
10
- if (typeof b !== "function" && b !== null)
11
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
12
- extendStatics(d, b);
13
- function __() { this.constructor = d; }
14
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
15
- };
16
- })();
17
- Object.defineProperty(exports, "__esModule", { value: true });
18
- exports.TransactionsAndReportingApiCustom = void 0;
19
- var base_1 = require("../base");
20
- var TransactionsAndReportingApiCustom = /** @class */ (function (_super) {
21
- __extends(TransactionsAndReportingApiCustom, _super);
22
- function TransactionsAndReportingApiCustom() {
23
- return _super !== null && _super.apply(this, arguments) || this;
24
- }
25
- return TransactionsAndReportingApiCustom;
26
- }(base_1.BaseAPI));
27
- exports.TransactionsAndReportingApiCustom = TransactionsAndReportingApiCustom;
1
+ "use strict";
2
+ var __extends = (this && this.__extends) || (function () {
3
+ var extendStatics = function (d, b) {
4
+ extendStatics = Object.setPrototypeOf ||
5
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
6
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
7
+ return extendStatics(d, b);
8
+ };
9
+ return function (d, b) {
10
+ if (typeof b !== "function" && b !== null)
11
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
12
+ extendStatics(d, b);
13
+ function __() { this.constructor = d; }
14
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
15
+ };
16
+ })();
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ exports.TransactionsAndReportingApiCustom = void 0;
19
+ var base_1 = require("../base");
20
+ var TransactionsAndReportingApiCustom = /** @class */ (function (_super) {
21
+ __extends(TransactionsAndReportingApiCustom, _super);
22
+ function TransactionsAndReportingApiCustom() {
23
+ return _super !== null && _super.apply(this, arguments) || this;
24
+ }
25
+ return TransactionsAndReportingApiCustom;
26
+ }(base_1.BaseAPI));
27
+ exports.TransactionsAndReportingApiCustom = TransactionsAndReportingApiCustom;
@@ -1,219 +1,218 @@
1
- /**
2
- * SnapTrade
3
- * Connect brokerage accounts to your app for live positions and trading
4
- *
5
- * The version of the OpenAPI document: 1.0.0
6
- * Contact: api@snaptrade.com
7
- *
8
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
9
- * https://konfigthis.com
10
- * Do not edit the class manually.
11
- */
12
- import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
- import { Configuration } from '../configuration';
14
- import { RequestArgs } from '../base';
15
- import { PerformanceCustom } from '../models';
16
- import { UniversalActivity } from '../models';
17
- import { TransactionsAndReportingApiCustom } from "./transactions-and-reporting-api-custom";
18
- /**
19
- * TransactionsAndReportingApi - axios parameter creator
20
- * @export
21
- */
22
- export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
23
- /**
24
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
25
- * @summary Get transaction history for a user
26
- * @param {string} userId
27
- * @param {string} userSecret
28
- * @param {string | Date} [startDate]
29
- * @param {string | Date} [endDate]
30
- * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
31
- * @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
32
- * @param {string} [type] Optional comma seperated list of types to filter activities by. 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
33
- * @param {*} [options] Override http request option.
34
- * @throws {RequiredError}
35
- */
36
- getActivities: (userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
- /**
38
- * 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
39
- * @summary Get performance information for a specific timeframe
40
- * @param {string | Date} startDate
41
- * @param {string | Date} endDate
42
- * @param {string} userId
43
- * @param {string} userSecret
44
- * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
45
- * @param {boolean} [detailed] Optional, increases frequency of data points for the total value and contribution charts if set to true
46
- * @param {string} [frequency] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
47
- * @param {*} [options] Override http request option.
48
- * @throws {RequiredError}
49
- */
50
- getReportingCustomRange: (startDate: string | Date, endDate: string | Date, userId: string, userSecret: string, accounts?: string, detailed?: boolean, frequency?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51
- };
52
- /**
53
- * TransactionsAndReportingApi - functional programming interface
54
- * @export
55
- */
56
- export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
57
- /**
58
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
59
- * @summary Get transaction history for a user
60
- * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
61
- * @param {*} [options] Override http request option.
62
- * @throws {RequiredError}
63
- */
64
- getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
65
- /**
66
- * 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
67
- * @summary Get performance information for a specific timeframe
68
- * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
69
- * @param {*} [options] Override http request option.
70
- * @throws {RequiredError}
71
- */
72
- getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PerformanceCustom>>;
73
- };
74
- /**
75
- * TransactionsAndReportingApi - factory interface
76
- * @export
77
- */
78
- export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
79
- /**
80
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
81
- * @summary Get transaction history for a user
82
- * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
83
- * @param {*} [options] Override http request option.
84
- * @throws {RequiredError}
85
- */
86
- getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
87
- /**
88
- * 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
89
- * @summary Get performance information for a specific timeframe
90
- * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
91
- * @param {*} [options] Override http request option.
92
- * @throws {RequiredError}
93
- */
94
- getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): AxiosPromise<PerformanceCustom>;
95
- };
96
- /**
97
- * Request parameters for getActivities operation in TransactionsAndReportingApi.
98
- * @export
99
- * @interface TransactionsAndReportingApiGetActivitiesRequest
100
- */
101
- export type TransactionsAndReportingApiGetActivitiesRequest = {
102
- /**
103
- *
104
- * @type {string}
105
- * @memberof TransactionsAndReportingApiGetActivities
106
- */
107
- readonly userId: string;
108
- /**
109
- *
110
- * @type {string}
111
- * @memberof TransactionsAndReportingApiGetActivities
112
- */
113
- readonly userSecret: string;
114
- /**
115
- *
116
- * @type {string | Date}
117
- * @memberof TransactionsAndReportingApiGetActivities
118
- */
119
- readonly startDate?: string | Date;
120
- /**
121
- *
122
- * @type {string | Date}
123
- * @memberof TransactionsAndReportingApiGetActivities
124
- */
125
- readonly endDate?: string | Date;
126
- /**
127
- * Optional comma seperated list of account IDs used to filter the request on specific accounts
128
- * @type {string}
129
- * @memberof TransactionsAndReportingApiGetActivities
130
- */
131
- readonly accounts?: string;
132
- /**
133
- * Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
134
- * @type {string}
135
- * @memberof TransactionsAndReportingApiGetActivities
136
- */
137
- readonly brokerageAuthorizations?: string;
138
- /**
139
- * Optional comma seperated list of types to filter activities by. 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
140
- * @type {string}
141
- * @memberof TransactionsAndReportingApiGetActivities
142
- */
143
- readonly type?: string;
144
- };
145
- /**
146
- * Request parameters for getReportingCustomRange operation in TransactionsAndReportingApi.
147
- * @export
148
- * @interface TransactionsAndReportingApiGetReportingCustomRangeRequest
149
- */
150
- export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
151
- /**
152
- *
153
- * @type {string | Date}
154
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
155
- */
156
- readonly startDate: string | Date;
157
- /**
158
- *
159
- * @type {string | Date}
160
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
161
- */
162
- readonly endDate: string | Date;
163
- /**
164
- *
165
- * @type {string}
166
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
167
- */
168
- readonly userId: string;
169
- /**
170
- *
171
- * @type {string}
172
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
173
- */
174
- readonly userSecret: string;
175
- /**
176
- * Optional comma seperated list of account IDs used to filter the request on specific accounts
177
- * @type {string}
178
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
179
- */
180
- readonly accounts?: string;
181
- /**
182
- * Optional, increases frequency of data points for the total value and contribution charts if set to true
183
- * @type {boolean}
184
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
185
- */
186
- readonly detailed?: boolean;
187
- /**
188
- * Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
189
- * @type {string}
190
- * @memberof TransactionsAndReportingApiGetReportingCustomRange
191
- */
192
- readonly frequency?: string;
193
- };
194
- /**
195
- * TransactionsAndReportingApi - object-oriented interface
196
- * @export
197
- * @class TransactionsAndReportingApi
198
- * @extends {BaseAPI}
199
- */
200
- export declare class TransactionsAndReportingApi extends TransactionsAndReportingApiCustom {
201
- /**
202
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
203
- * @summary Get transaction history for a user
204
- * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
205
- * @param {*} [options] Override http request option.
206
- * @throws {RequiredError}
207
- * @memberof TransactionsAndReportingApi
208
- */
209
- getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any>>;
210
- /**
211
- * 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
212
- * @summary Get performance information for a specific timeframe
213
- * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
214
- * @param {*} [options] Override http request option.
215
- * @throws {RequiredError}
216
- * @memberof TransactionsAndReportingApi
217
- */
218
- getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PerformanceCustom, any>>;
219
- }
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 } from '../base';
14
+ import { PerformanceCustom } from '../models';
15
+ import { UniversalActivity } from '../models';
16
+ import { TransactionsAndReportingApiCustom } from "./transactions-and-reporting-api-custom";
17
+ /**
18
+ * TransactionsAndReportingApi - axios parameter creator
19
+ * @export
20
+ */
21
+ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
24
+ * @summary Get transaction history for a user
25
+ * @param {string} userId
26
+ * @param {string} userSecret
27
+ * @param {string | Date} [startDate]
28
+ * @param {string | Date} [endDate]
29
+ * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
30
+ * @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
31
+ * @param {string} [type] Optional comma seperated list of types to filter activities by. 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
32
+ * @param {*} [options] Override http request option.
33
+ * @throws {RequiredError}
34
+ */
35
+ getActivities: (userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
+ /**
37
+ * 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
38
+ * @summary Get performance information for a specific timeframe
39
+ * @param {string | Date} startDate
40
+ * @param {string | Date} endDate
41
+ * @param {string} userId
42
+ * @param {string} userSecret
43
+ * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
44
+ * @param {boolean} [detailed] Optional, increases frequency of data points for the total value and contribution charts if set to true
45
+ * @param {string} [frequency] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ getReportingCustomRange: (startDate: string | Date, endDate: string | Date, userId: string, userSecret: string, accounts?: string, detailed?: boolean, frequency?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
+ };
51
+ /**
52
+ * TransactionsAndReportingApi - functional programming interface
53
+ * @export
54
+ */
55
+ export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
56
+ /**
57
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
58
+ * @summary Get transaction history for a user
59
+ * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
60
+ * @param {*} [options] Override http request option.
61
+ * @throws {RequiredError}
62
+ */
63
+ getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
64
+ /**
65
+ * 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
66
+ * @summary Get performance information for a specific timeframe
67
+ * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
68
+ * @param {*} [options] Override http request option.
69
+ * @throws {RequiredError}
70
+ */
71
+ getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PerformanceCustom>>;
72
+ };
73
+ /**
74
+ * TransactionsAndReportingApi - factory interface
75
+ * @export
76
+ */
77
+ export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
78
+ /**
79
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
80
+ * @summary Get transaction history for a user
81
+ * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
82
+ * @param {*} [options] Override http request option.
83
+ * @throws {RequiredError}
84
+ */
85
+ getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
86
+ /**
87
+ * 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
88
+ * @summary Get performance information for a specific timeframe
89
+ * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
90
+ * @param {*} [options] Override http request option.
91
+ * @throws {RequiredError}
92
+ */
93
+ getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): AxiosPromise<PerformanceCustom>;
94
+ };
95
+ /**
96
+ * Request parameters for getActivities operation in TransactionsAndReportingApi.
97
+ * @export
98
+ * @interface TransactionsAndReportingApiGetActivitiesRequest
99
+ */
100
+ export type TransactionsAndReportingApiGetActivitiesRequest = {
101
+ /**
102
+ *
103
+ * @type {string}
104
+ * @memberof TransactionsAndReportingApiGetActivities
105
+ */
106
+ readonly userId: string;
107
+ /**
108
+ *
109
+ * @type {string}
110
+ * @memberof TransactionsAndReportingApiGetActivities
111
+ */
112
+ readonly userSecret: string;
113
+ /**
114
+ *
115
+ * @type {string | Date}
116
+ * @memberof TransactionsAndReportingApiGetActivities
117
+ */
118
+ readonly startDate?: string | Date;
119
+ /**
120
+ *
121
+ * @type {string | Date}
122
+ * @memberof TransactionsAndReportingApiGetActivities
123
+ */
124
+ readonly endDate?: string | Date;
125
+ /**
126
+ * Optional comma seperated list of account IDs used to filter the request on specific accounts
127
+ * @type {string}
128
+ * @memberof TransactionsAndReportingApiGetActivities
129
+ */
130
+ readonly accounts?: string;
131
+ /**
132
+ * Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
133
+ * @type {string}
134
+ * @memberof TransactionsAndReportingApiGetActivities
135
+ */
136
+ readonly brokerageAuthorizations?: string;
137
+ /**
138
+ * Optional comma seperated list of types to filter activities by. 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
139
+ * @type {string}
140
+ * @memberof TransactionsAndReportingApiGetActivities
141
+ */
142
+ readonly type?: string;
143
+ };
144
+ /**
145
+ * Request parameters for getReportingCustomRange operation in TransactionsAndReportingApi.
146
+ * @export
147
+ * @interface TransactionsAndReportingApiGetReportingCustomRangeRequest
148
+ */
149
+ export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
150
+ /**
151
+ *
152
+ * @type {string | Date}
153
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
154
+ */
155
+ readonly startDate: string | Date;
156
+ /**
157
+ *
158
+ * @type {string | Date}
159
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
160
+ */
161
+ readonly endDate: string | Date;
162
+ /**
163
+ *
164
+ * @type {string}
165
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
166
+ */
167
+ readonly userId: string;
168
+ /**
169
+ *
170
+ * @type {string}
171
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
172
+ */
173
+ readonly userSecret: string;
174
+ /**
175
+ * Optional comma seperated list of account IDs used to filter the request on specific accounts
176
+ * @type {string}
177
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
178
+ */
179
+ readonly accounts?: string;
180
+ /**
181
+ * Optional, increases frequency of data points for the total value and contribution charts if set to true
182
+ * @type {boolean}
183
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
184
+ */
185
+ readonly detailed?: boolean;
186
+ /**
187
+ * Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
188
+ * @type {string}
189
+ * @memberof TransactionsAndReportingApiGetReportingCustomRange
190
+ */
191
+ readonly frequency?: string;
192
+ };
193
+ /**
194
+ * TransactionsAndReportingApi - object-oriented interface
195
+ * @export
196
+ * @class TransactionsAndReportingApi
197
+ * @extends {BaseAPI}
198
+ */
199
+ export declare class TransactionsAndReportingApi extends TransactionsAndReportingApiCustom {
200
+ /**
201
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
202
+ * @summary Get transaction history for a user
203
+ * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
204
+ * @param {*} [options] Override http request option.
205
+ * @throws {RequiredError}
206
+ * @memberof TransactionsAndReportingApi
207
+ */
208
+ getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any>>;
209
+ /**
210
+ * 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
211
+ * @summary Get performance information for a specific timeframe
212
+ * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
213
+ * @param {*} [options] Override http request option.
214
+ * @throws {RequiredError}
215
+ * @memberof TransactionsAndReportingApi
216
+ */
217
+ getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PerformanceCustom, any>>;
218
+ }