snaptrade-typescript-sdk 8.16.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 ConnectionsApiCustom extends BaseAPI {
3
- }
1
+ import { BaseAPI } from "../base";
2
+ export declare class ConnectionsApiCustom 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.ConnectionsApiCustom = void 0;
19
- var base_1 = require("../base");
20
- var ConnectionsApiCustom = /** @class */ (function (_super) {
21
- __extends(ConnectionsApiCustom, _super);
22
- function ConnectionsApiCustom() {
23
- return _super !== null && _super.apply(this, arguments) || this;
24
- }
25
- return ConnectionsApiCustom;
26
- }(base_1.BaseAPI));
27
- exports.ConnectionsApiCustom = ConnectionsApiCustom;
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.ConnectionsApiCustom = void 0;
19
+ var base_1 = require("../base");
20
+ var ConnectionsApiCustom = /** @class */ (function (_super) {
21
+ __extends(ConnectionsApiCustom, _super);
22
+ function ConnectionsApiCustom() {
23
+ return _super !== null && _super.apply(this, arguments) || this;
24
+ }
25
+ return ConnectionsApiCustom;
26
+ }(base_1.BaseAPI));
27
+ exports.ConnectionsApiCustom = ConnectionsApiCustom;
@@ -1,276 +1,275 @@
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 { BrokerageAuthorization } from '../models';
16
- import { ConnectionsSessionEvents200ResponseInner } from '../models';
17
- import { ConnectionsApiCustom } from "./connections-api-custom";
18
- /**
19
- * ConnectionsApi - axios parameter creator
20
- * @export
21
- */
22
- export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
23
- /**
24
- *
25
- * @summary Get detail of a specific brokerage authorizations for the user
26
- * @param {string} authorizationId The ID of a brokerage authorization object.
27
- * @param {string} userId
28
- * @param {string} userSecret
29
- * @param {*} [options] Override http request option.
30
- * @throws {RequiredError}
31
- */
32
- detailBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
- /**
34
- *
35
- * @summary List all brokerage authorizations for the user
36
- * @param {string} userId
37
- * @param {string} userSecret
38
- * @param {*} [options] Override http request option.
39
- * @throws {RequiredError}
40
- */
41
- listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
- /**
43
- *
44
- * @summary Remove a brokerage authorization.
45
- * @param {string} authorizationId The ID of the Authorization to delete.
46
- * @param {string} userId
47
- * @param {string} userSecret
48
- * @param {*} [options] Override http request option.
49
- * @throws {RequiredError}
50
- */
51
- removeBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
- /**
53
- *
54
- * @summary List all session events for the partner
55
- * @param {string} partnerClientId
56
- * @param {string} [userId] Optional comma seperated list of user IDs used to filter the request on specific users
57
- * @param {string} [sessionId] Optional comma seperated list of session IDs used to filter the request on specific users
58
- * @param {*} [options] Override http request option.
59
- * @throws {RequiredError}
60
- */
61
- sessionEvents: (partnerClientId: string, userId?: string, sessionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
62
- };
63
- /**
64
- * ConnectionsApi - functional programming interface
65
- * @export
66
- */
67
- export declare const ConnectionsApiFp: (configuration?: Configuration) => {
68
- /**
69
- *
70
- * @summary Get detail of a specific brokerage authorizations for the user
71
- * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
72
- * @param {*} [options] Override http request option.
73
- * @throws {RequiredError}
74
- */
75
- detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorization>>;
76
- /**
77
- *
78
- * @summary List all brokerage authorizations for the user
79
- * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
80
- * @param {*} [options] Override http request option.
81
- * @throws {RequiredError}
82
- */
83
- listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
84
- /**
85
- *
86
- * @summary Remove a brokerage authorization.
87
- * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
88
- * @param {*} [options] Override http request option.
89
- * @throws {RequiredError}
90
- */
91
- removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
92
- /**
93
- *
94
- * @summary List all session events for the partner
95
- * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
96
- * @param {*} [options] Override http request option.
97
- * @throws {RequiredError}
98
- */
99
- sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>>;
100
- };
101
- /**
102
- * ConnectionsApi - factory interface
103
- * @export
104
- */
105
- export declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
106
- /**
107
- *
108
- * @summary Get detail of a specific brokerage authorizations for the user
109
- * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
110
- * @param {*} [options] Override http request option.
111
- * @throws {RequiredError}
112
- */
113
- detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorization>;
114
- /**
115
- *
116
- * @summary List all brokerage authorizations for the user
117
- * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
118
- * @param {*} [options] Override http request option.
119
- * @throws {RequiredError}
120
- */
121
- listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
122
- /**
123
- *
124
- * @summary Remove a brokerage authorization.
125
- * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
126
- * @param {*} [options] Override http request option.
127
- * @throws {RequiredError}
128
- */
129
- removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
130
- /**
131
- *
132
- * @summary List all session events for the partner
133
- * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
134
- * @param {*} [options] Override http request option.
135
- * @throws {RequiredError}
136
- */
137
- sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>;
138
- };
139
- /**
140
- * Request parameters for detailBrokerageAuthorization operation in ConnectionsApi.
141
- * @export
142
- * @interface ConnectionsApiDetailBrokerageAuthorizationRequest
143
- */
144
- export type ConnectionsApiDetailBrokerageAuthorizationRequest = {
145
- /**
146
- * The ID of a brokerage authorization object.
147
- * @type {string}
148
- * @memberof ConnectionsApiDetailBrokerageAuthorization
149
- */
150
- readonly authorizationId: string;
151
- /**
152
- *
153
- * @type {string}
154
- * @memberof ConnectionsApiDetailBrokerageAuthorization
155
- */
156
- readonly userId: string;
157
- /**
158
- *
159
- * @type {string}
160
- * @memberof ConnectionsApiDetailBrokerageAuthorization
161
- */
162
- readonly userSecret: string;
163
- };
164
- /**
165
- * Request parameters for listBrokerageAuthorizations operation in ConnectionsApi.
166
- * @export
167
- * @interface ConnectionsApiListBrokerageAuthorizationsRequest
168
- */
169
- export type ConnectionsApiListBrokerageAuthorizationsRequest = {
170
- /**
171
- *
172
- * @type {string}
173
- * @memberof ConnectionsApiListBrokerageAuthorizations
174
- */
175
- readonly userId: string;
176
- /**
177
- *
178
- * @type {string}
179
- * @memberof ConnectionsApiListBrokerageAuthorizations
180
- */
181
- readonly userSecret: string;
182
- };
183
- /**
184
- * Request parameters for removeBrokerageAuthorization operation in ConnectionsApi.
185
- * @export
186
- * @interface ConnectionsApiRemoveBrokerageAuthorizationRequest
187
- */
188
- export type ConnectionsApiRemoveBrokerageAuthorizationRequest = {
189
- /**
190
- * The ID of the Authorization to delete.
191
- * @type {string}
192
- * @memberof ConnectionsApiRemoveBrokerageAuthorization
193
- */
194
- readonly authorizationId: string;
195
- /**
196
- *
197
- * @type {string}
198
- * @memberof ConnectionsApiRemoveBrokerageAuthorization
199
- */
200
- readonly userId: string;
201
- /**
202
- *
203
- * @type {string}
204
- * @memberof ConnectionsApiRemoveBrokerageAuthorization
205
- */
206
- readonly userSecret: string;
207
- };
208
- /**
209
- * Request parameters for sessionEvents operation in ConnectionsApi.
210
- * @export
211
- * @interface ConnectionsApiSessionEventsRequest
212
- */
213
- export type ConnectionsApiSessionEventsRequest = {
214
- /**
215
- *
216
- * @type {string}
217
- * @memberof ConnectionsApiSessionEvents
218
- */
219
- readonly partnerClientId: string;
220
- /**
221
- * Optional comma seperated list of user IDs used to filter the request on specific users
222
- * @type {string}
223
- * @memberof ConnectionsApiSessionEvents
224
- */
225
- readonly userId?: string;
226
- /**
227
- * Optional comma seperated list of session IDs used to filter the request on specific users
228
- * @type {string}
229
- * @memberof ConnectionsApiSessionEvents
230
- */
231
- readonly sessionId?: string;
232
- };
233
- /**
234
- * ConnectionsApi - object-oriented interface
235
- * @export
236
- * @class ConnectionsApi
237
- * @extends {BaseAPI}
238
- */
239
- export declare class ConnectionsApi extends ConnectionsApiCustom {
240
- /**
241
- *
242
- * @summary Get detail of a specific brokerage authorizations for the user
243
- * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
244
- * @param {*} [options] Override http request option.
245
- * @throws {RequiredError}
246
- * @memberof ConnectionsApi
247
- */
248
- detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization, any>>;
249
- /**
250
- *
251
- * @summary List all brokerage authorizations for the user
252
- * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
253
- * @param {*} [options] Override http request option.
254
- * @throws {RequiredError}
255
- * @memberof ConnectionsApi
256
- */
257
- listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any>>;
258
- /**
259
- *
260
- * @summary Remove a brokerage authorization.
261
- * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
262
- * @param {*} [options] Override http request option.
263
- * @throws {RequiredError}
264
- * @memberof ConnectionsApi
265
- */
266
- removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
267
- /**
268
- *
269
- * @summary List all session events for the partner
270
- * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
271
- * @param {*} [options] Override http request option.
272
- * @throws {RequiredError}
273
- * @memberof ConnectionsApi
274
- */
275
- sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").SessionEvent[], any>>;
276
- }
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 { BrokerageAuthorization } from '../models';
15
+ import { ConnectionsSessionEvents200ResponseInner } from '../models';
16
+ import { ConnectionsApiCustom } from "./connections-api-custom";
17
+ /**
18
+ * ConnectionsApi - axios parameter creator
19
+ * @export
20
+ */
21
+ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ *
24
+ * @summary Get detail of a specific brokerage authorizations for the user
25
+ * @param {string} authorizationId The ID of a brokerage authorization object.
26
+ * @param {string} userId
27
+ * @param {string} userSecret
28
+ * @param {*} [options] Override http request option.
29
+ * @throws {RequiredError}
30
+ */
31
+ detailBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
+ /**
33
+ *
34
+ * @summary List all brokerage authorizations for the user
35
+ * @param {string} userId
36
+ * @param {string} userSecret
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
+ /**
42
+ *
43
+ * @summary Remove a brokerage authorization.
44
+ * @param {string} authorizationId The ID of the Authorization to delete.
45
+ * @param {string} userId
46
+ * @param {string} userSecret
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ removeBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51
+ /**
52
+ *
53
+ * @summary List all session events for the partner
54
+ * @param {string} partnerClientId
55
+ * @param {string} [userId] Optional comma seperated list of user IDs used to filter the request on specific users
56
+ * @param {string} [sessionId] Optional comma seperated list of session IDs used to filter the request on specific users
57
+ * @param {*} [options] Override http request option.
58
+ * @throws {RequiredError}
59
+ */
60
+ sessionEvents: (partnerClientId: string, userId?: string, sessionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
61
+ };
62
+ /**
63
+ * ConnectionsApi - functional programming interface
64
+ * @export
65
+ */
66
+ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
67
+ /**
68
+ *
69
+ * @summary Get detail of a specific brokerage authorizations for the user
70
+ * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
71
+ * @param {*} [options] Override http request option.
72
+ * @throws {RequiredError}
73
+ */
74
+ detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorization>>;
75
+ /**
76
+ *
77
+ * @summary List all brokerage authorizations for the user
78
+ * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
79
+ * @param {*} [options] Override http request option.
80
+ * @throws {RequiredError}
81
+ */
82
+ listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
83
+ /**
84
+ *
85
+ * @summary Remove a brokerage authorization.
86
+ * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
87
+ * @param {*} [options] Override http request option.
88
+ * @throws {RequiredError}
89
+ */
90
+ removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
91
+ /**
92
+ *
93
+ * @summary List all session events for the partner
94
+ * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
95
+ * @param {*} [options] Override http request option.
96
+ * @throws {RequiredError}
97
+ */
98
+ sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>>;
99
+ };
100
+ /**
101
+ * ConnectionsApi - factory interface
102
+ * @export
103
+ */
104
+ export declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
105
+ /**
106
+ *
107
+ * @summary Get detail of a specific brokerage authorizations for the user
108
+ * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
109
+ * @param {*} [options] Override http request option.
110
+ * @throws {RequiredError}
111
+ */
112
+ detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorization>;
113
+ /**
114
+ *
115
+ * @summary List all brokerage authorizations for the user
116
+ * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
121
+ /**
122
+ *
123
+ * @summary Remove a brokerage authorization.
124
+ * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
125
+ * @param {*} [options] Override http request option.
126
+ * @throws {RequiredError}
127
+ */
128
+ removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
129
+ /**
130
+ *
131
+ * @summary List all session events for the partner
132
+ * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
133
+ * @param {*} [options] Override http request option.
134
+ * @throws {RequiredError}
135
+ */
136
+ sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>;
137
+ };
138
+ /**
139
+ * Request parameters for detailBrokerageAuthorization operation in ConnectionsApi.
140
+ * @export
141
+ * @interface ConnectionsApiDetailBrokerageAuthorizationRequest
142
+ */
143
+ export type ConnectionsApiDetailBrokerageAuthorizationRequest = {
144
+ /**
145
+ * The ID of a brokerage authorization object.
146
+ * @type {string}
147
+ * @memberof ConnectionsApiDetailBrokerageAuthorization
148
+ */
149
+ readonly authorizationId: string;
150
+ /**
151
+ *
152
+ * @type {string}
153
+ * @memberof ConnectionsApiDetailBrokerageAuthorization
154
+ */
155
+ readonly userId: string;
156
+ /**
157
+ *
158
+ * @type {string}
159
+ * @memberof ConnectionsApiDetailBrokerageAuthorization
160
+ */
161
+ readonly userSecret: string;
162
+ };
163
+ /**
164
+ * Request parameters for listBrokerageAuthorizations operation in ConnectionsApi.
165
+ * @export
166
+ * @interface ConnectionsApiListBrokerageAuthorizationsRequest
167
+ */
168
+ export type ConnectionsApiListBrokerageAuthorizationsRequest = {
169
+ /**
170
+ *
171
+ * @type {string}
172
+ * @memberof ConnectionsApiListBrokerageAuthorizations
173
+ */
174
+ readonly userId: string;
175
+ /**
176
+ *
177
+ * @type {string}
178
+ * @memberof ConnectionsApiListBrokerageAuthorizations
179
+ */
180
+ readonly userSecret: string;
181
+ };
182
+ /**
183
+ * Request parameters for removeBrokerageAuthorization operation in ConnectionsApi.
184
+ * @export
185
+ * @interface ConnectionsApiRemoveBrokerageAuthorizationRequest
186
+ */
187
+ export type ConnectionsApiRemoveBrokerageAuthorizationRequest = {
188
+ /**
189
+ * The ID of the Authorization to delete.
190
+ * @type {string}
191
+ * @memberof ConnectionsApiRemoveBrokerageAuthorization
192
+ */
193
+ readonly authorizationId: string;
194
+ /**
195
+ *
196
+ * @type {string}
197
+ * @memberof ConnectionsApiRemoveBrokerageAuthorization
198
+ */
199
+ readonly userId: string;
200
+ /**
201
+ *
202
+ * @type {string}
203
+ * @memberof ConnectionsApiRemoveBrokerageAuthorization
204
+ */
205
+ readonly userSecret: string;
206
+ };
207
+ /**
208
+ * Request parameters for sessionEvents operation in ConnectionsApi.
209
+ * @export
210
+ * @interface ConnectionsApiSessionEventsRequest
211
+ */
212
+ export type ConnectionsApiSessionEventsRequest = {
213
+ /**
214
+ *
215
+ * @type {string}
216
+ * @memberof ConnectionsApiSessionEvents
217
+ */
218
+ readonly partnerClientId: string;
219
+ /**
220
+ * Optional comma seperated list of user IDs used to filter the request on specific users
221
+ * @type {string}
222
+ * @memberof ConnectionsApiSessionEvents
223
+ */
224
+ readonly userId?: string;
225
+ /**
226
+ * Optional comma seperated list of session IDs used to filter the request on specific users
227
+ * @type {string}
228
+ * @memberof ConnectionsApiSessionEvents
229
+ */
230
+ readonly sessionId?: string;
231
+ };
232
+ /**
233
+ * ConnectionsApi - object-oriented interface
234
+ * @export
235
+ * @class ConnectionsApi
236
+ * @extends {BaseAPI}
237
+ */
238
+ export declare class ConnectionsApi extends ConnectionsApiCustom {
239
+ /**
240
+ *
241
+ * @summary Get detail of a specific brokerage authorizations for the user
242
+ * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ * @memberof ConnectionsApi
246
+ */
247
+ detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization, any>>;
248
+ /**
249
+ *
250
+ * @summary List all brokerage authorizations for the user
251
+ * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
252
+ * @param {*} [options] Override http request option.
253
+ * @throws {RequiredError}
254
+ * @memberof ConnectionsApi
255
+ */
256
+ listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any>>;
257
+ /**
258
+ *
259
+ * @summary Remove a brokerage authorization.
260
+ * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
261
+ * @param {*} [options] Override http request option.
262
+ * @throws {RequiredError}
263
+ * @memberof ConnectionsApi
264
+ */
265
+ removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
266
+ /**
267
+ *
268
+ * @summary List all session events for the partner
269
+ * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
270
+ * @param {*} [options] Override http request option.
271
+ * @throws {RequiredError}
272
+ * @memberof ConnectionsApi
273
+ */
274
+ sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").SessionEvent[], any>>;
275
+ }