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,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.AuthenticationApiCustom = void 0;
19
- var base_1 = require("../base");
20
- var AuthenticationApiCustom = /** @class */ (function (_super) {
21
- __extends(AuthenticationApiCustom, _super);
22
- function AuthenticationApiCustom() {
23
- return _super !== null && _super.apply(this, arguments) || this;
24
- }
25
- return AuthenticationApiCustom;
26
- }(base_1.BaseAPI));
27
- exports.AuthenticationApiCustom = AuthenticationApiCustom;
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.AuthenticationApiCustom = void 0;
19
+ var base_1 = require("../base");
20
+ var AuthenticationApiCustom = /** @class */ (function (_super) {
21
+ __extends(AuthenticationApiCustom, _super);
22
+ function AuthenticationApiCustom() {
23
+ return _super !== null && _super.apply(this, arguments) || this;
24
+ }
25
+ return AuthenticationApiCustom;
26
+ }(base_1.BaseAPI));
27
+ exports.AuthenticationApiCustom = AuthenticationApiCustom;
@@ -1,267 +1,267 @@
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 { AuthenticationLoginSnapTradeUser200Response } from '../models';
15
- import { DeleteUserResponse } from '../models';
16
- import { EncryptedResponse } from '../models';
17
- import { SnapTradeLoginUserRequestBody } from '../models';
18
- import { SnapTradeRegisterUserRequestBody } from '../models';
19
- import { UserIDandSecret } from '../models';
20
- import { AuthenticationApiCustom } from "./authentication-api-custom";
21
- /**
22
- * AuthenticationApi - axios parameter creator
23
- * @export
24
- */
25
- export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
26
- /**
27
- *
28
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
29
- * @param {string} userId
30
- * @param {*} [options] Override http request option.
31
- * @throws {RequiredError}
32
- */
33
- deleteSnapTradeUser: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
- /**
35
- *
36
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
37
- * @param {string} userId
38
- * @param {string} userSecret
39
- * @param {*} [options] Override http request option.
40
- * @throws {RequiredError}
41
- */
42
- getUserJWT: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
- /**
44
- *
45
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
46
- * @param {*} [options] Override http request option.
47
- * @throws {RequiredError}
48
- */
49
- listSnapTradeUsers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
- /**
51
- *
52
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
53
- * @param {string} userId
54
- * @param {string} userSecret
55
- * @param {SnapTradeLoginUserRequestBody} [snapTradeLoginUserRequestBody]
56
- * @param {*} [options] Override http request option.
57
- * @throws {RequiredError}
58
- */
59
- loginSnapTradeUser: (userId: string, userSecret: string, snapTradeLoginUserRequestBody?: SnapTradeLoginUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
60
- /**
61
- *
62
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
63
- * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
64
- * @param {*} [options] Override http request option.
65
- * @throws {RequiredError}
66
- */
67
- registerSnapTradeUser: (snapTradeRegisterUserRequestBody: SnapTradeRegisterUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
- };
69
- /**
70
- * AuthenticationApi - functional programming interface
71
- * @export
72
- */
73
- export declare const AuthenticationApiFp: (configuration?: Configuration) => {
74
- /**
75
- *
76
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
77
- * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
78
- * @param {*} [options] Override http request option.
79
- * @throws {RequiredError}
80
- */
81
- deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUserResponse>>;
82
- /**
83
- *
84
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
85
- * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
86
- * @param {*} [options] Override http request option.
87
- * @throws {RequiredError}
88
- */
89
- getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EncryptedResponse>>;
90
- /**
91
- *
92
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
93
- * @param {*} [options] Override http request option.
94
- * @throws {RequiredError}
95
- */
96
- listSnapTradeUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
97
- /**
98
- *
99
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
100
- * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
101
- * @param {*} [options] Override http request option.
102
- * @throws {RequiredError}
103
- */
104
- loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationLoginSnapTradeUser200Response>>;
105
- /**
106
- *
107
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
108
- * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
109
- * @param {*} [options] Override http request option.
110
- * @throws {RequiredError}
111
- */
112
- registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserIDandSecret>>;
113
- };
114
- /**
115
- * AuthenticationApi - factory interface
116
- * @export
117
- */
118
- export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
119
- /**
120
- *
121
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
122
- * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
123
- * @param {*} [options] Override http request option.
124
- * @throws {RequiredError}
125
- */
126
- deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteUserResponse>;
127
- /**
128
- *
129
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
130
- * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
131
- * @param {*} [options] Override http request option.
132
- * @throws {RequiredError}
133
- */
134
- getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): AxiosPromise<EncryptedResponse>;
135
- /**
136
- *
137
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
138
- * @param {*} [options] Override http request option.
139
- * @throws {RequiredError}
140
- */
141
- listSnapTradeUsers(options?: AxiosRequestConfig): AxiosPromise<Array<string>>;
142
- /**
143
- *
144
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
145
- * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
146
- * @param {*} [options] Override http request option.
147
- * @throws {RequiredError}
148
- */
149
- loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<AuthenticationLoginSnapTradeUser200Response>;
150
- /**
151
- *
152
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
153
- * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
154
- * @param {*} [options] Override http request option.
155
- * @throws {RequiredError}
156
- */
157
- registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<UserIDandSecret>;
158
- };
159
- /**
160
- * Request parameters for deleteSnapTradeUser operation in AuthenticationApi.
161
- * @export
162
- * @interface AuthenticationApiDeleteSnapTradeUserRequest
163
- */
164
- export type AuthenticationApiDeleteSnapTradeUserRequest = {
165
- /**
166
- *
167
- * @type {string}
168
- * @memberof AuthenticationApiDeleteSnapTradeUser
169
- */
170
- readonly userId: string;
171
- };
172
- /**
173
- * Request parameters for getUserJWT operation in AuthenticationApi.
174
- * @export
175
- * @interface AuthenticationApiGetUserJWTRequest
176
- */
177
- export type AuthenticationApiGetUserJWTRequest = {
178
- /**
179
- *
180
- * @type {string}
181
- * @memberof AuthenticationApiGetUserJWT
182
- */
183
- readonly userId: string;
184
- /**
185
- *
186
- * @type {string}
187
- * @memberof AuthenticationApiGetUserJWT
188
- */
189
- readonly userSecret: string;
190
- };
191
- /**
192
- * Request parameters for loginSnapTradeUser operation in AuthenticationApi.
193
- * @export
194
- * @interface AuthenticationApiLoginSnapTradeUserRequest
195
- */
196
- export type AuthenticationApiLoginSnapTradeUserRequest = {
197
- /**
198
- *
199
- * @type {string}
200
- * @memberof AuthenticationApiLoginSnapTradeUser
201
- */
202
- readonly userId: string;
203
- /**
204
- *
205
- * @type {string}
206
- * @memberof AuthenticationApiLoginSnapTradeUser
207
- */
208
- readonly userSecret: string;
209
- } & SnapTradeLoginUserRequestBody;
210
- /**
211
- * Request parameters for registerSnapTradeUser operation in AuthenticationApi.
212
- * @export
213
- * @interface AuthenticationApiRegisterSnapTradeUserRequest
214
- */
215
- export type AuthenticationApiRegisterSnapTradeUserRequest = {} & SnapTradeRegisterUserRequestBody;
216
- /**
217
- * AuthenticationApi - object-oriented interface
218
- * @export
219
- * @class AuthenticationApi
220
- * @extends {BaseAPI}
221
- */
222
- export declare class AuthenticationApi extends AuthenticationApiCustom {
223
- /**
224
- *
225
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
226
- * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
227
- * @param {*} [options] Override http request option.
228
- * @throws {RequiredError}
229
- * @memberof AuthenticationApi
230
- */
231
- deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteUserResponse, any>>;
232
- /**
233
- *
234
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
235
- * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
236
- * @param {*} [options] Override http request option.
237
- * @throws {RequiredError}
238
- * @memberof AuthenticationApi
239
- */
240
- getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EncryptedResponse, any>>;
241
- /**
242
- *
243
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
244
- * @param {*} [options] Override http request option.
245
- * @throws {RequiredError}
246
- * @memberof AuthenticationApi
247
- */
248
- listSnapTradeUsers(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
249
- /**
250
- *
251
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
252
- * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
253
- * @param {*} [options] Override http request option.
254
- * @throws {RequiredError}
255
- * @memberof AuthenticationApi
256
- */
257
- loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationLoginSnapTradeUser200Response, any>>;
258
- /**
259
- *
260
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
261
- * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
262
- * @param {*} [options] Override http request option.
263
- * @throws {RequiredError}
264
- * @memberof AuthenticationApi
265
- */
266
- registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserIDandSecret, any>>;
267
- }
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 { AuthenticationLoginSnapTradeUser200Response } from '../models';
15
+ import { DeleteUserResponse } from '../models';
16
+ import { EncryptedResponse } from '../models';
17
+ import { SnapTradeLoginUserRequestBody } from '../models';
18
+ import { SnapTradeRegisterUserRequestBody } from '../models';
19
+ import { UserIDandSecret } from '../models';
20
+ import { AuthenticationApiCustom } from "./authentication-api-custom";
21
+ /**
22
+ * AuthenticationApi - axios parameter creator
23
+ * @export
24
+ */
25
+ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ /**
27
+ *
28
+ * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
29
+ * @param {string} userId
30
+ * @param {*} [options] Override http request option.
31
+ * @throws {RequiredError}
32
+ */
33
+ deleteSnapTradeUser: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
+ /**
35
+ *
36
+ * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
37
+ * @param {string} userId
38
+ * @param {string} userSecret
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ getUserJWT: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
+ /**
44
+ *
45
+ * @summary Get a list of all SnapTrade users you\'ve registered on our platform
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ listSnapTradeUsers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
+ /**
51
+ *
52
+ * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
53
+ * @param {string} userId
54
+ * @param {string} userSecret
55
+ * @param {SnapTradeLoginUserRequestBody} [snapTradeLoginUserRequestBody]
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ */
59
+ loginSnapTradeUser: (userId: string, userSecret: string, snapTradeLoginUserRequestBody?: SnapTradeLoginUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
60
+ /**
61
+ *
62
+ * @summary Register user with SnapTrade in order to create secure brokerage authorizations
63
+ * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
64
+ * @param {*} [options] Override http request option.
65
+ * @throws {RequiredError}
66
+ */
67
+ registerSnapTradeUser: (snapTradeRegisterUserRequestBody: SnapTradeRegisterUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
+ };
69
+ /**
70
+ * AuthenticationApi - functional programming interface
71
+ * @export
72
+ */
73
+ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
74
+ /**
75
+ *
76
+ * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
77
+ * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUserResponse>>;
82
+ /**
83
+ *
84
+ * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
85
+ * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EncryptedResponse>>;
90
+ /**
91
+ *
92
+ * @summary Get a list of all SnapTrade users you\'ve registered on our platform
93
+ * @param {*} [options] Override http request option.
94
+ * @throws {RequiredError}
95
+ */
96
+ listSnapTradeUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
97
+ /**
98
+ *
99
+ * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
100
+ * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationLoginSnapTradeUser200Response>>;
105
+ /**
106
+ *
107
+ * @summary Register user with SnapTrade in order to create secure brokerage authorizations
108
+ * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
109
+ * @param {*} [options] Override http request option.
110
+ * @throws {RequiredError}
111
+ */
112
+ registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserIDandSecret>>;
113
+ };
114
+ /**
115
+ * AuthenticationApi - factory interface
116
+ * @export
117
+ */
118
+ export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
119
+ /**
120
+ *
121
+ * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
122
+ * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
123
+ * @param {*} [options] Override http request option.
124
+ * @throws {RequiredError}
125
+ */
126
+ deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteUserResponse>;
127
+ /**
128
+ *
129
+ * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
130
+ * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
131
+ * @param {*} [options] Override http request option.
132
+ * @throws {RequiredError}
133
+ */
134
+ getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): AxiosPromise<EncryptedResponse>;
135
+ /**
136
+ *
137
+ * @summary Get a list of all SnapTrade users you\'ve registered on our platform
138
+ * @param {*} [options] Override http request option.
139
+ * @throws {RequiredError}
140
+ */
141
+ listSnapTradeUsers(options?: AxiosRequestConfig): AxiosPromise<Array<string>>;
142
+ /**
143
+ *
144
+ * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
145
+ * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
146
+ * @param {*} [options] Override http request option.
147
+ * @throws {RequiredError}
148
+ */
149
+ loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<AuthenticationLoginSnapTradeUser200Response>;
150
+ /**
151
+ *
152
+ * @summary Register user with SnapTrade in order to create secure brokerage authorizations
153
+ * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
154
+ * @param {*} [options] Override http request option.
155
+ * @throws {RequiredError}
156
+ */
157
+ registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<UserIDandSecret>;
158
+ };
159
+ /**
160
+ * Request parameters for deleteSnapTradeUser operation in AuthenticationApi.
161
+ * @export
162
+ * @interface AuthenticationApiDeleteSnapTradeUserRequest
163
+ */
164
+ export type AuthenticationApiDeleteSnapTradeUserRequest = {
165
+ /**
166
+ *
167
+ * @type {string}
168
+ * @memberof AuthenticationApiDeleteSnapTradeUser
169
+ */
170
+ readonly userId: string;
171
+ };
172
+ /**
173
+ * Request parameters for getUserJWT operation in AuthenticationApi.
174
+ * @export
175
+ * @interface AuthenticationApiGetUserJWTRequest
176
+ */
177
+ export type AuthenticationApiGetUserJWTRequest = {
178
+ /**
179
+ *
180
+ * @type {string}
181
+ * @memberof AuthenticationApiGetUserJWT
182
+ */
183
+ readonly userId: string;
184
+ /**
185
+ *
186
+ * @type {string}
187
+ * @memberof AuthenticationApiGetUserJWT
188
+ */
189
+ readonly userSecret: string;
190
+ };
191
+ /**
192
+ * Request parameters for loginSnapTradeUser operation in AuthenticationApi.
193
+ * @export
194
+ * @interface AuthenticationApiLoginSnapTradeUserRequest
195
+ */
196
+ export type AuthenticationApiLoginSnapTradeUserRequest = {
197
+ /**
198
+ *
199
+ * @type {string}
200
+ * @memberof AuthenticationApiLoginSnapTradeUser
201
+ */
202
+ readonly userId: string;
203
+ /**
204
+ *
205
+ * @type {string}
206
+ * @memberof AuthenticationApiLoginSnapTradeUser
207
+ */
208
+ readonly userSecret: string;
209
+ } & SnapTradeLoginUserRequestBody;
210
+ /**
211
+ * Request parameters for registerSnapTradeUser operation in AuthenticationApi.
212
+ * @export
213
+ * @interface AuthenticationApiRegisterSnapTradeUserRequest
214
+ */
215
+ export type AuthenticationApiRegisterSnapTradeUserRequest = {} & SnapTradeRegisterUserRequestBody;
216
+ /**
217
+ * AuthenticationApi - object-oriented interface
218
+ * @export
219
+ * @class AuthenticationApi
220
+ * @extends {BaseAPI}
221
+ */
222
+ export declare class AuthenticationApi extends AuthenticationApiCustom {
223
+ /**
224
+ *
225
+ * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
226
+ * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
227
+ * @param {*} [options] Override http request option.
228
+ * @throws {RequiredError}
229
+ * @memberof AuthenticationApi
230
+ */
231
+ deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteUserResponse, any>>;
232
+ /**
233
+ *
234
+ * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
235
+ * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
236
+ * @param {*} [options] Override http request option.
237
+ * @throws {RequiredError}
238
+ * @memberof AuthenticationApi
239
+ */
240
+ getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EncryptedResponse, any>>;
241
+ /**
242
+ *
243
+ * @summary Get a list of all SnapTrade users you\'ve registered on our platform
244
+ * @param {*} [options] Override http request option.
245
+ * @throws {RequiredError}
246
+ * @memberof AuthenticationApi
247
+ */
248
+ listSnapTradeUsers(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
249
+ /**
250
+ *
251
+ * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
252
+ * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
253
+ * @param {*} [options] Override http request option.
254
+ * @throws {RequiredError}
255
+ * @memberof AuthenticationApi
256
+ */
257
+ loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationLoginSnapTradeUser200Response, any>>;
258
+ /**
259
+ *
260
+ * @summary Register user with SnapTrade in order to create secure brokerage authorizations
261
+ * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
262
+ * @param {*} [options] Override http request option.
263
+ * @throws {RequiredError}
264
+ * @memberof AuthenticationApi
265
+ */
266
+ registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserIDandSecret, any>>;
267
+ }