snaptrade-typescript-sdk 8.28.2 → 8.29.1

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 (265) hide show
  1. package/README.md +1661 -57
  2. package/dist/api/account-information-api-generated.d.ts +6 -16
  3. package/dist/api/account-information-api-generated.js +13 -13
  4. package/dist/api/api-status-api-generated.d.ts +0 -10
  5. package/dist/api/api-status-api-generated.js +10 -10
  6. package/dist/api/authentication-api-generated.d.ts +0 -10
  7. package/dist/api/authentication-api-generated.js +10 -10
  8. package/dist/api/connections-api-generated.d.ts +0 -10
  9. package/dist/api/connections-api-generated.js +10 -10
  10. package/dist/api/error-logs-api-generated.d.ts +0 -10
  11. package/dist/api/error-logs-api-generated.js +10 -10
  12. package/dist/api/options-api-generated.d.ts +10 -20
  13. package/dist/api/options-api-generated.js +15 -15
  14. package/dist/api/reference-data-api-generated.d.ts +2 -12
  15. package/dist/api/reference-data-api-generated.js +11 -11
  16. package/dist/api/trading-api-generated.d.ts +2 -12
  17. package/dist/api/trading-api-generated.js +11 -11
  18. package/dist/api/transactions-and-reporting-api-generated.d.ts +0 -10
  19. package/dist/api/transactions-and-reporting-api-generated.js +10 -10
  20. package/dist/api.d.ts +0 -10
  21. package/dist/api.js +10 -10
  22. package/dist/base.d.ts +0 -10
  23. package/dist/base.js +10 -10
  24. package/dist/browser.js +1 -1
  25. package/dist/client.d.ts +0 -10
  26. package/dist/client.js +10 -10
  27. package/dist/common.d.ts +0 -10
  28. package/dist/common.js +10 -10
  29. package/dist/configuration.d.ts +5 -10
  30. package/dist/configuration.js +11 -11
  31. package/dist/error.d.ts +0 -10
  32. package/dist/error.js +10 -10
  33. package/dist/index.d.ts +0 -10
  34. package/dist/index.js +10 -10
  35. package/dist/models/account-holdings-account.d.ts +0 -10
  36. package/dist/models/account-holdings-account.js +10 -12
  37. package/dist/models/account-holdings.d.ts +0 -10
  38. package/dist/models/account-holdings.js +10 -12
  39. package/dist/models/account-order-record-status.d.ts +0 -10
  40. package/dist/models/account-order-record-status.js +10 -12
  41. package/dist/models/account-order-record.d.ts +0 -10
  42. package/dist/models/account-order-record.js +10 -12
  43. package/dist/models/account-simple.d.ts +0 -10
  44. package/dist/models/account-simple.js +10 -12
  45. package/dist/models/account-sync-status.d.ts +0 -10
  46. package/dist/models/account-sync-status.js +10 -12
  47. package/dist/models/account.d.ts +0 -10
  48. package/dist/models/account.js +10 -12
  49. package/dist/models/action.d.ts +0 -10
  50. package/dist/models/action.js +10 -12
  51. package/dist/models/authentication-login-snap-trade-user200-response.d.ts +0 -10
  52. package/dist/models/authentication-login-snap-trade-user200-response.js +10 -12
  53. package/dist/models/balance.d.ts +0 -10
  54. package/dist/models/balance.js +10 -12
  55. package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +0 -10
  56. package/dist/models/brokerage-authorization-type-read-only-brokerage.js +10 -12
  57. package/dist/models/brokerage-authorization-type-read-only.d.ts +0 -10
  58. package/dist/models/brokerage-authorization-type-read-only.js +10 -12
  59. package/dist/models/brokerage-authorization-type.d.ts +0 -10
  60. package/dist/models/brokerage-authorization-type.js +10 -12
  61. package/dist/models/brokerage-authorization.d.ts +0 -10
  62. package/dist/models/brokerage-authorization.js +10 -12
  63. package/dist/models/brokerage-symbol-option-symbol.d.ts +0 -10
  64. package/dist/models/brokerage-symbol-option-symbol.js +10 -12
  65. package/dist/models/brokerage-symbol-symbol.d.ts +6 -16
  66. package/dist/models/brokerage-symbol-symbol.js +10 -12
  67. package/dist/models/brokerage-symbol.d.ts +0 -10
  68. package/dist/models/brokerage-symbol.js +10 -12
  69. package/dist/models/brokerage-type.d.ts +0 -10
  70. package/dist/models/brokerage-type.js +10 -12
  71. package/dist/models/brokerage.d.ts +0 -10
  72. package/dist/models/brokerage.js +10 -12
  73. package/dist/models/calculated-trade.d.ts +0 -10
  74. package/dist/models/calculated-trade.js +10 -12
  75. package/dist/models/cash-restriction.d.ts +0 -10
  76. package/dist/models/cash-restriction.js +10 -12
  77. package/dist/models/connections-session-events200-response-inner.d.ts +0 -10
  78. package/dist/models/connections-session-events200-response-inner.js +10 -12
  79. package/dist/models/currency.d.ts +0 -10
  80. package/dist/models/currency.js +10 -12
  81. package/dist/models/delete-user-response.d.ts +0 -10
  82. package/dist/models/delete-user-response.js +10 -12
  83. package/dist/models/dividend-at-date.d.ts +0 -10
  84. package/dist/models/dividend-at-date.js +10 -12
  85. package/dist/models/encrypted-response-encrypted-message-data.d.ts +0 -10
  86. package/dist/models/encrypted-response-encrypted-message-data.js +10 -12
  87. package/dist/models/encrypted-response.d.ts +0 -10
  88. package/dist/models/encrypted-response.js +10 -12
  89. package/dist/models/exchange-rate-pairs.d.ts +0 -10
  90. package/dist/models/exchange-rate-pairs.js +10 -12
  91. package/dist/models/exchange.d.ts +0 -10
  92. package/dist/models/exchange.js +10 -12
  93. package/dist/models/excluded-asset.d.ts +0 -10
  94. package/dist/models/excluded-asset.js +10 -12
  95. package/dist/models/jwt.d.ts +0 -10
  96. package/dist/models/jwt.js +10 -12
  97. package/dist/models/login-redirect-uri.d.ts +0 -10
  98. package/dist/models/login-redirect-uri.js +10 -12
  99. package/dist/models/manual-trade-and-impact.d.ts +0 -10
  100. package/dist/models/manual-trade-and-impact.js +10 -12
  101. package/dist/models/manual-trade-balance.d.ts +0 -10
  102. package/dist/models/manual-trade-balance.js +10 -12
  103. package/dist/models/manual-trade-form.d.ts +0 -10
  104. package/dist/models/manual-trade-form.js +10 -12
  105. package/dist/models/manual-trade-symbol.d.ts +0 -10
  106. package/dist/models/manual-trade-symbol.js +10 -12
  107. package/dist/models/manual-trade.d.ts +0 -10
  108. package/dist/models/manual-trade.js +10 -12
  109. package/dist/models/model-asset-class-details.d.ts +0 -10
  110. package/dist/models/model-asset-class-details.js +10 -12
  111. package/dist/models/model-asset-class-target.d.ts +0 -10
  112. package/dist/models/model-asset-class-target.js +10 -12
  113. package/dist/models/model-asset-class.d.ts +0 -10
  114. package/dist/models/model-asset-class.js +10 -12
  115. package/dist/models/model-portfolio-asset-class.d.ts +0 -10
  116. package/dist/models/model-portfolio-asset-class.js +10 -12
  117. package/dist/models/model-portfolio-details.d.ts +0 -10
  118. package/dist/models/model-portfolio-details.js +10 -12
  119. package/dist/models/model-portfolio-security.d.ts +0 -10
  120. package/dist/models/model-portfolio-security.js +10 -12
  121. package/dist/models/model-portfolio.d.ts +0 -10
  122. package/dist/models/model-portfolio.js +10 -12
  123. package/dist/models/model400-failed-request-response.d.ts +0 -10
  124. package/dist/models/model400-failed-request-response.js +10 -12
  125. package/dist/models/model401-failed-request-response.d.ts +0 -10
  126. package/dist/models/model401-failed-request-response.js +10 -12
  127. package/dist/models/model403-failed-request-response.d.ts +0 -10
  128. package/dist/models/model403-failed-request-response.js +10 -12
  129. package/dist/models/model404-failed-request-response.d.ts +0 -10
  130. package/dist/models/model404-failed-request-response.js +10 -12
  131. package/dist/models/monthly-dividends.d.ts +0 -10
  132. package/dist/models/monthly-dividends.js +10 -12
  133. package/dist/models/net-contributions.d.ts +0 -10
  134. package/dist/models/net-contributions.js +10 -12
  135. package/dist/models/net-dividend.d.ts +0 -10
  136. package/dist/models/net-dividend.js +10 -12
  137. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +0 -10
  138. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +10 -12
  139. package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +0 -10
  140. package/dist/models/option-chain-inner-chain-per-root-inner.js +10 -12
  141. package/dist/models/option-chain-inner.d.ts +0 -10
  142. package/dist/models/option-chain-inner.js +10 -12
  143. package/dist/models/option-leg.d.ts +0 -10
  144. package/dist/models/option-leg.js +10 -12
  145. package/dist/models/option-strategy-legs-inner.d.ts +0 -10
  146. package/dist/models/option-strategy-legs-inner.js +10 -12
  147. package/dist/models/option-strategy.d.ts +0 -10
  148. package/dist/models/option-strategy.js +10 -12
  149. package/dist/models/options-get-option-strategy-request.d.ts +0 -10
  150. package/dist/models/options-get-option-strategy-request.js +10 -12
  151. package/dist/models/options-holdings.d.ts +0 -10
  152. package/dist/models/options-holdings.js +10 -12
  153. package/dist/models/options-place-option-strategy-request.d.ts +0 -10
  154. package/dist/models/options-place-option-strategy-request.js +10 -12
  155. package/dist/models/options-position-currency.d.ts +0 -10
  156. package/dist/models/options-position-currency.js +10 -12
  157. package/dist/models/options-position.d.ts +0 -22
  158. package/dist/models/options-position.js +10 -12
  159. package/dist/models/options-symbol.d.ts +0 -10
  160. package/dist/models/options-symbol.js +10 -12
  161. package/dist/models/order-type.d.ts +0 -10
  162. package/dist/models/order-type.js +10 -12
  163. package/dist/models/partner-data.d.ts +0 -10
  164. package/dist/models/partner-data.js +10 -12
  165. package/dist/models/past-value.d.ts +0 -10
  166. package/dist/models/past-value.js +10 -12
  167. package/dist/models/performance-custom.d.ts +0 -10
  168. package/dist/models/performance-custom.js +10 -12
  169. package/dist/models/portfolio-group-info.d.ts +0 -10
  170. package/dist/models/portfolio-group-info.js +10 -12
  171. package/dist/models/portfolio-group-position.d.ts +0 -10
  172. package/dist/models/portfolio-group-position.js +10 -12
  173. package/dist/models/portfolio-group-settings.d.ts +0 -10
  174. package/dist/models/portfolio-group-settings.js +10 -12
  175. package/dist/models/portfolio-group.d.ts +0 -10
  176. package/dist/models/portfolio-group.js +10 -12
  177. package/dist/models/position-symbol.d.ts +0 -10
  178. package/dist/models/position-symbol.js +10 -12
  179. package/dist/models/position.d.ts +0 -10
  180. package/dist/models/position.js +10 -12
  181. package/dist/models/redirect-tokenand-pin.d.ts +0 -10
  182. package/dist/models/redirect-tokenand-pin.js +10 -12
  183. package/dist/models/security-type.d.ts +0 -10
  184. package/dist/models/security-type.js +10 -12
  185. package/dist/models/session-event.d.ts +0 -10
  186. package/dist/models/session-event.js +10 -12
  187. package/dist/models/snap-trade-apidisclaimer-accept-status.d.ts +0 -10
  188. package/dist/models/snap-trade-apidisclaimer-accept-status.js +10 -12
  189. package/dist/models/snap-trade-holdings-account-account-id.d.ts +0 -10
  190. package/dist/models/snap-trade-holdings-account-account-id.js +10 -12
  191. package/dist/models/snap-trade-holdings-account.d.ts +0 -10
  192. package/dist/models/snap-trade-holdings-account.js +10 -12
  193. package/dist/models/snap-trade-holdings-total-value.d.ts +0 -10
  194. package/dist/models/snap-trade-holdings-total-value.js +10 -12
  195. package/dist/models/snap-trade-login-user-request-body.d.ts +0 -10
  196. package/dist/models/snap-trade-login-user-request-body.js +10 -12
  197. package/dist/models/snap-trade-register-user-request-body.d.ts +0 -10
  198. package/dist/models/snap-trade-register-user-request-body.js +10 -12
  199. package/dist/models/status.d.ts +0 -10
  200. package/dist/models/status.js +10 -12
  201. package/dist/models/strategy-impact-legs-inner.d.ts +0 -10
  202. package/dist/models/strategy-impact-legs-inner.js +10 -12
  203. package/dist/models/strategy-impact.d.ts +0 -10
  204. package/dist/models/strategy-impact.js +10 -12
  205. package/dist/models/strategy-order-place-orders-inner-legs-inner.d.ts +0 -10
  206. package/dist/models/strategy-order-place-orders-inner-legs-inner.js +10 -12
  207. package/dist/models/strategy-order-place-orders-inner.d.ts +0 -10
  208. package/dist/models/strategy-order-place-orders-inner.js +10 -12
  209. package/dist/models/strategy-order-place.d.ts +0 -10
  210. package/dist/models/strategy-order-place.js +10 -12
  211. package/dist/models/strategy-order-record.d.ts +0 -10
  212. package/dist/models/strategy-order-record.js +10 -12
  213. package/dist/models/strategy-quotes-greek.d.ts +0 -10
  214. package/dist/models/strategy-quotes-greek.js +10 -12
  215. package/dist/models/strategy-quotes.d.ts +0 -10
  216. package/dist/models/strategy-quotes.js +10 -12
  217. package/dist/models/sub-period-return-rate.d.ts +0 -10
  218. package/dist/models/sub-period-return-rate.js +10 -12
  219. package/dist/models/symbol-query.d.ts +0 -10
  220. package/dist/models/symbol-query.js +10 -12
  221. package/dist/models/symbol.d.ts +0 -10
  222. package/dist/models/symbol.js +10 -12
  223. package/dist/models/symbols-quotes-inner.d.ts +0 -10
  224. package/dist/models/symbols-quotes-inner.js +10 -12
  225. package/dist/models/target-asset.d.ts +0 -10
  226. package/dist/models/target-asset.js +10 -12
  227. package/dist/models/time-in-force.d.ts +0 -10
  228. package/dist/models/time-in-force.js +10 -12
  229. package/dist/models/trade-execution-status.d.ts +0 -10
  230. package/dist/models/trade-execution-status.js +10 -12
  231. package/dist/models/trade-impact.d.ts +0 -10
  232. package/dist/models/trade-impact.js +10 -12
  233. package/dist/models/trade.d.ts +0 -10
  234. package/dist/models/trade.js +10 -12
  235. package/dist/models/trading-cancel-user-account-order-request.d.ts +0 -10
  236. package/dist/models/trading-cancel-user-account-order-request.js +10 -12
  237. package/dist/models/trading-place-ocoorder-request.d.ts +0 -10
  238. package/dist/models/trading-place-ocoorder-request.js +10 -12
  239. package/dist/models/transactions-status.d.ts +0 -10
  240. package/dist/models/transactions-status.js +10 -12
  241. package/dist/models/underlying-symbol.d.ts +0 -10
  242. package/dist/models/underlying-symbol.js +10 -12
  243. package/dist/models/universal-activity.d.ts +1 -11
  244. package/dist/models/universal-activity.js +10 -12
  245. package/dist/models/universal-symbol-ticker.d.ts +0 -10
  246. package/dist/models/universal-symbol-ticker.js +10 -12
  247. package/dist/models/universal-symbol.d.ts +6 -16
  248. package/dist/models/universal-symbol.js +10 -12
  249. package/dist/models/user-error-log.d.ts +0 -10
  250. package/dist/models/user-error-log.js +10 -12
  251. package/dist/models/user-idand-secret.d.ts +0 -10
  252. package/dist/models/user-idand-secret.js +10 -12
  253. package/dist/models/user-settings.d.ts +0 -10
  254. package/dist/models/user-settings.js +10 -12
  255. package/dist/models/usexchange.d.ts +0 -10
  256. package/dist/models/usexchange.js +10 -12
  257. package/dist/pagination/page-types.d.ts +0 -10
  258. package/dist/pagination/page-types.js +10 -10
  259. package/dist/pagination/page.d.ts +0 -10
  260. package/dist/pagination/page.js +10 -10
  261. package/dist/pagination/pageable.d.ts +0 -10
  262. package/dist/pagination/pageable.js +10 -10
  263. package/dist/pagination/paginate.d.ts +0 -10
  264. package/dist/pagination/paginate.js +10 -10
  265. package/package.json +4 -1
@@ -1,13 +1,3 @@
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
1
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
2
  import { Configuration } from '../configuration';
13
3
  import { RequestArgs, BaseAPI } from '../base';
@@ -38,7 +28,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
38
28
  * @summary List account balances
39
29
  * @param {string} userId
40
30
  * @param {string} userSecret
41
- * @param {string} accountId The ID of the account get positions.
31
+ * @param {string} accountId The ID of the account to get balances.
42
32
  * @param {*} [options] Override http request option.
43
33
  * @throws {RequiredError}
44
34
  */
@@ -58,7 +48,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
58
48
  * @summary Get history of orders placed in account
59
49
  * @param {string} userId
60
50
  * @param {string} userSecret
61
- * @param {string} accountId The ID of the account get positions.
51
+ * @param {string} accountId The ID of the account to get orders.
62
52
  * @param {'all' | 'open' | 'executed'} [state] defaults value is set to \"all\"
63
53
  * @param {*} [options] Override http request option.
64
54
  * @throws {RequiredError}
@@ -69,7 +59,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
69
59
  * @summary List account positions
70
60
  * @param {string} userId
71
61
  * @param {string} userSecret
72
- * @param {string} accountId The ID of the account get positions.
62
+ * @param {string} accountId The ID of the account to get positions.
73
63
  * @param {*} [options] Override http request option.
74
64
  * @throws {RequiredError}
75
65
  */
@@ -290,7 +280,7 @@ export type AccountInformationApiGetUserAccountBalanceRequest = {
290
280
  */
291
281
  readonly userSecret: string;
292
282
  /**
293
- * The ID of the account get positions.
283
+ * The ID of the account to get balances.
294
284
  * @type {string}
295
285
  * @memberof AccountInformationApiGetUserAccountBalance
296
286
  */
@@ -340,7 +330,7 @@ export type AccountInformationApiGetUserAccountOrdersRequest = {
340
330
  */
341
331
  readonly userSecret: string;
342
332
  /**
343
- * The ID of the account get positions.
333
+ * The ID of the account to get orders.
344
334
  * @type {string}
345
335
  * @memberof AccountInformationApiGetUserAccountOrders
346
336
  */
@@ -371,7 +361,7 @@ export type AccountInformationApiGetUserAccountPositionsRequest = {
371
361
  */
372
362
  readonly userSecret: string;
373
363
  /**
374
- * The ID of the account get positions.
364
+ * The ID of the account to get positions.
375
365
  * @type {string}
376
366
  * @memberof AccountInformationApiGetUserAccountPositions
377
367
  */
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
4
+ /*
5
+ SnapTrade
6
+
7
+ Connect brokerage accounts to your app for live positions and trading
8
+
9
+ The version of the OpenAPI document: 1.0.0
10
+ Contact: api@snaptrade.com
11
+
12
+ NOTE: This file is auto generated by Konfig (https://konfigthis.com).
13
+ */
14
14
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
15
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
16
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -94,7 +94,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
94
94
  * @summary List account balances
95
95
  * @param {string} userId
96
96
  * @param {string} userSecret
97
- * @param {string} accountId The ID of the account get positions.
97
+ * @param {string} accountId The ID of the account to get balances.
98
98
  * @param {*} [options] Override http request option.
99
99
  * @throws {RequiredError}
100
100
  */
@@ -200,7 +200,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
200
200
  * @summary Get history of orders placed in account
201
201
  * @param {string} userId
202
202
  * @param {string} userSecret
203
- * @param {string} accountId The ID of the account get positions.
203
+ * @param {string} accountId The ID of the account to get orders.
204
204
  * @param {'all' | 'open' | 'executed'} [state] defaults value is set to \"all\"
205
205
  * @param {*} [options] Override http request option.
206
206
  * @throws {RequiredError}
@@ -257,7 +257,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
257
257
  * @summary List account positions
258
258
  * @param {string} userId
259
259
  * @param {string} userSecret
260
- * @param {string} accountId The ID of the account get positions.
260
+ * @param {string} accountId The ID of the account to get positions.
261
261
  * @param {*} [options] Override http request option.
262
262
  * @throws {RequiredError}
263
263
  */
@@ -1,13 +1,3 @@
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
1
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
2
  import { Configuration } from '../configuration';
13
3
  import { RequestArgs, BaseAPI } from '../base';
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
4
+ /*
5
+ SnapTrade
6
+
7
+ Connect brokerage accounts to your app for live positions and trading
8
+
9
+ The version of the OpenAPI document: 1.0.0
10
+ Contact: api@snaptrade.com
11
+
12
+ NOTE: This file is auto generated by Konfig (https://konfigthis.com).
13
+ */
14
14
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
15
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
16
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -1,13 +1,3 @@
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
1
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
2
  import { Configuration } from '../configuration';
13
3
  import { RequestArgs, BaseAPI } from '../base';
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
4
+ /*
5
+ SnapTrade
6
+
7
+ Connect brokerage accounts to your app for live positions and trading
8
+
9
+ The version of the OpenAPI document: 1.0.0
10
+ Contact: api@snaptrade.com
11
+
12
+ NOTE: This file is auto generated by Konfig (https://konfigthis.com).
13
+ */
14
14
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
15
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
16
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -1,13 +1,3 @@
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
1
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
2
  import { Configuration } from '../configuration';
13
3
  import { RequestArgs, BaseAPI } from '../base';
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
4
+ /*
5
+ SnapTrade
6
+
7
+ Connect brokerage accounts to your app for live positions and trading
8
+
9
+ The version of the OpenAPI document: 1.0.0
10
+ Contact: api@snaptrade.com
11
+
12
+ NOTE: This file is auto generated by Konfig (https://konfigthis.com).
13
+ */
14
14
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
15
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
16
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -1,13 +1,3 @@
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
1
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
2
  import { Configuration } from '../configuration';
13
3
  import { RequestArgs, BaseAPI } from '../base';
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
4
+ /*
5
+ SnapTrade
6
+
7
+ Connect brokerage accounts to your app for live positions and trading
8
+
9
+ The version of the OpenAPI document: 1.0.0
10
+ Contact: api@snaptrade.com
11
+
12
+ NOTE: This file is auto generated by Konfig (https://konfigthis.com).
13
+ */
14
14
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
15
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
16
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -1,13 +1,3 @@
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
1
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
2
  import { Configuration } from '../configuration';
13
3
  import { RequestArgs, BaseAPI } from '../base';
@@ -27,7 +17,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
27
17
  * @summary Creates an option strategy object that will be used to place an option strategy order
28
18
  * @param {string} userId
29
19
  * @param {string} userSecret
30
- * @param {string} accountId The ID of the account get positions.
20
+ * @param {string} accountId The ID of the account to create the option strategy object in.
31
21
  * @param {OptionsGetOptionStrategyRequest} optionsGetOptionStrategyRequest
32
22
  * @param {*} [options] Override http request option.
33
23
  * @throws {RequiredError}
@@ -38,7 +28,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
38
28
  * @summary Get the options chain
39
29
  * @param {string} userId
40
30
  * @param {string} userSecret
41
- * @param {string} accountId The ID of the account get positions.
31
+ * @param {string} accountId The ID of the account to get the options chain from.
42
32
  * @param {string} symbol Universal symbol ID if symbol
43
33
  * @param {*} [options] Override http request option.
44
34
  * @throws {RequiredError}
@@ -49,7 +39,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
49
39
  * @summary Get latest market data of option strategy
50
40
  * @param {string} userId
51
41
  * @param {string} userSecret
52
- * @param {string} accountId The ID of the account get positions.
42
+ * @param {string} accountId The ID of the account the strategy will be placed in.
53
43
  * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
54
44
  * @param {*} [options] Override http request option.
55
45
  * @throws {RequiredError}
@@ -60,7 +50,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
60
50
  * @summary Get the options holdings in the account
61
51
  * @param {string} userId
62
52
  * @param {string} userSecret
63
- * @param {string} accountId The ID of the account get positions.
53
+ * @param {string} accountId The ID of the account to fetch options holdings for.
64
54
  * @param {*} [options] Override http request option.
65
55
  * @throws {RequiredError}
66
56
  */
@@ -70,7 +60,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
70
60
  * @summary Place an option strategy order on the brokerage
71
61
  * @param {string} userId
72
62
  * @param {string} userSecret
73
- * @param {string} accountId The ID of the account get positions.
63
+ * @param {string} accountId The ID of the account to execute the strategy in.
74
64
  * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
75
65
  * @param {OptionsPlaceOptionStrategyRequest} optionsPlaceOptionStrategyRequest
76
66
  * @param {*} [options] Override http request option.
@@ -189,7 +179,7 @@ export type OptionsApiGetOptionStrategyRequest = {
189
179
  */
190
180
  readonly userSecret: string;
191
181
  /**
192
- * The ID of the account get positions.
182
+ * The ID of the account to create the option strategy object in.
193
183
  * @type {string}
194
184
  * @memberof OptionsApiGetOptionStrategy
195
185
  */
@@ -214,7 +204,7 @@ export type OptionsApiGetOptionsChainRequest = {
214
204
  */
215
205
  readonly userSecret: string;
216
206
  /**
217
- * The ID of the account get positions.
207
+ * The ID of the account to get the options chain from.
218
208
  * @type {string}
219
209
  * @memberof OptionsApiGetOptionsChain
220
210
  */
@@ -245,7 +235,7 @@ export type OptionsApiGetOptionsStrategyQuoteRequest = {
245
235
  */
246
236
  readonly userSecret: string;
247
237
  /**
248
- * The ID of the account get positions.
238
+ * The ID of the account the strategy will be placed in.
249
239
  * @type {string}
250
240
  * @memberof OptionsApiGetOptionsStrategyQuote
251
241
  */
@@ -276,7 +266,7 @@ export type OptionsApiListOptionHoldingsRequest = {
276
266
  */
277
267
  readonly userSecret: string;
278
268
  /**
279
- * The ID of the account get positions.
269
+ * The ID of the account to fetch options holdings for.
280
270
  * @type {string}
281
271
  * @memberof OptionsApiListOptionHoldings
282
272
  */
@@ -301,7 +291,7 @@ export type OptionsApiPlaceOptionStrategyRequest = {
301
291
  */
302
292
  readonly userSecret: string;
303
293
  /**
304
- * The ID of the account get positions.
294
+ * The ID of the account to execute the strategy in.
305
295
  * @type {string}
306
296
  * @memberof OptionsApiPlaceOptionStrategy
307
297
  */
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
4
+ /*
5
+ SnapTrade
6
+
7
+ Connect brokerage accounts to your app for live positions and trading
8
+
9
+ The version of the OpenAPI document: 1.0.0
10
+ Contact: api@snaptrade.com
11
+
12
+ NOTE: This file is auto generated by Konfig (https://konfigthis.com).
13
+ */
14
14
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
15
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
16
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -40,7 +40,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
40
40
  * @summary Creates an option strategy object that will be used to place an option strategy order
41
41
  * @param {string} userId
42
42
  * @param {string} userSecret
43
- * @param {string} accountId The ID of the account get positions.
43
+ * @param {string} accountId The ID of the account to create the option strategy object in.
44
44
  * @param {OptionsGetOptionStrategyRequest} optionsGetOptionStrategyRequest
45
45
  * @param {*} [options] Override http request option.
46
46
  * @throws {RequiredError}
@@ -99,7 +99,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
99
99
  * @summary Get the options chain
100
100
  * @param {string} userId
101
101
  * @param {string} userSecret
102
- * @param {string} accountId The ID of the account get positions.
102
+ * @param {string} accountId The ID of the account to get the options chain from.
103
103
  * @param {string} symbol Universal symbol ID if symbol
104
104
  * @param {*} [options] Override http request option.
105
105
  * @throws {RequiredError}
@@ -158,7 +158,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
158
158
  * @summary Get latest market data of option strategy
159
159
  * @param {string} userId
160
160
  * @param {string} userSecret
161
- * @param {string} accountId The ID of the account get positions.
161
+ * @param {string} accountId The ID of the account the strategy will be placed in.
162
162
  * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
163
163
  * @param {*} [options] Override http request option.
164
164
  * @throws {RequiredError}
@@ -215,7 +215,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
215
215
  * @summary Get the options holdings in the account
216
216
  * @param {string} userId
217
217
  * @param {string} userSecret
218
- * @param {string} accountId The ID of the account get positions.
218
+ * @param {string} accountId The ID of the account to fetch options holdings for.
219
219
  * @param {*} [options] Override http request option.
220
220
  * @throws {RequiredError}
221
221
  */
@@ -268,7 +268,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
268
268
  * @summary Place an option strategy order on the brokerage
269
269
  * @param {string} userId
270
270
  * @param {string} userSecret
271
- * @param {string} accountId The ID of the account get positions.
271
+ * @param {string} accountId The ID of the account to execute the strategy in.
272
272
  * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
273
273
  * @param {OptionsPlaceOptionStrategyRequest} optionsPlaceOptionStrategyRequest
274
274
  * @param {*} [options] Override http request option.
@@ -1,13 +1,3 @@
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
1
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
2
  import { Configuration } from '../configuration';
13
3
  import { RequestArgs, BaseAPI } from '../base';
@@ -105,7 +95,7 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
105
95
  * @summary Search for symbols available in an account
106
96
  * @param {string} userId
107
97
  * @param {string} userSecret
108
- * @param {string} accountId The ID of the account get positions.
98
+ * @param {string} accountId The ID of the account to search for symbols within.
109
99
  * @param {SymbolQuery} [symbolQuery]
110
100
  * @param {*} [options] Override http request option.
111
101
  * @throws {RequiredError}
@@ -358,7 +348,7 @@ export type ReferenceDataApiSymbolSearchUserAccountRequest = {
358
348
  */
359
349
  readonly userSecret: string;
360
350
  /**
361
- * The ID of the account get positions.
351
+ * The ID of the account to search for symbols within.
362
352
  * @type {string}
363
353
  * @memberof ReferenceDataApiSymbolSearchUserAccount
364
354
  */
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
4
+ /*
5
+ SnapTrade
6
+
7
+ Connect brokerage accounts to your app for live positions and trading
8
+
9
+ The version of the OpenAPI document: 1.0.0
10
+ Contact: api@snaptrade.com
11
+
12
+ NOTE: This file is auto generated by Konfig (https://konfigthis.com).
13
+ */
14
14
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
15
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
16
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -430,7 +430,7 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
430
430
  * @summary Search for symbols available in an account
431
431
  * @param {string} userId
432
432
  * @param {string} userSecret
433
- * @param {string} accountId The ID of the account get positions.
433
+ * @param {string} accountId The ID of the account to search for symbols within.
434
434
  * @param {SymbolQuery} [symbolQuery]
435
435
  * @param {*} [options] Override http request option.
436
436
  * @throws {RequiredError}
@@ -1,13 +1,3 @@
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
1
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
2
  import { Configuration } from '../configuration';
13
3
  import { RequestArgs, BaseAPI } from '../base';
@@ -27,7 +17,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
27
17
  * @summary Cancel open order in account
28
18
  * @param {string} userId
29
19
  * @param {string} userSecret
30
- * @param {string} accountId The ID of the account get positions.
20
+ * @param {string} accountId The ID of the account to cancel the order in.
31
21
  * @param {TradingCancelUserAccountOrderRequest} tradingCancelUserAccountOrderRequest The Order ID to be canceled
32
22
  * @param {*} [options] Override http request option.
33
23
  * @throws {RequiredError}
@@ -213,7 +203,7 @@ export type TradingApiCancelUserAccountOrderRequest = {
213
203
  */
214
204
  readonly userSecret: string;
215
205
  /**
216
- * The ID of the account get positions.
206
+ * The ID of the account to cancel the order in.
217
207
  * @type {string}
218
208
  * @memberof TradingApiCancelUserAccountOrder
219
209
  */
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
4
+ /*
5
+ SnapTrade
6
+
7
+ Connect brokerage accounts to your app for live positions and trading
8
+
9
+ The version of the OpenAPI document: 1.0.0
10
+ Contact: api@snaptrade.com
11
+
12
+ NOTE: This file is auto generated by Konfig (https://konfigthis.com).
13
+ */
14
14
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
15
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
16
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -40,7 +40,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
40
40
  * @summary Cancel open order in account
41
41
  * @param {string} userId
42
42
  * @param {string} userSecret
43
- * @param {string} accountId The ID of the account get positions.
43
+ * @param {string} accountId The ID of the account to cancel the order in.
44
44
  * @param {TradingCancelUserAccountOrderRequest} tradingCancelUserAccountOrderRequest The Order ID to be canceled
45
45
  * @param {*} [options] Override http request option.
46
46
  * @throws {RequiredError}
@@ -1,13 +1,3 @@
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
1
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
2
  import { Configuration } from '../configuration';
13
3
  import { RequestArgs, BaseAPI } from '../base';
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
- /**
5
- * SnapTrade
6
- * Connect brokerage accounts to your app for live positions and trading
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: api@snaptrade.com
10
- *
11
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
12
- * Do not edit the class manually.
13
- */
4
+ /*
5
+ SnapTrade
6
+
7
+ Connect brokerage accounts to your app for live positions and trading
8
+
9
+ The version of the OpenAPI document: 1.0.0
10
+ Contact: api@snaptrade.com
11
+
12
+ NOTE: This file is auto generated by Konfig (https://konfigthis.com).
13
+ */
14
14
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
15
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
16
  return new (P || (P = Promise))(function (resolve, reject) {