snaptrade-typescript-sdk 9.0.15 → 9.0.17

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.
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Connect brokerage accounts to your app for live positions and trading
8
8
 
9
- [![npm](https://img.shields.io/badge/npm-v9.0.15-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.15)
9
+ [![npm](https://img.shields.io/badge/npm-v9.0.17-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.17)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -57,7 +57,6 @@ Connect brokerage accounts to your app for live positions and trading
57
57
  * [`snaptrade.trading.getOrderImpact`](#snaptradetradinggetorderimpact)
58
58
  * [`snaptrade.trading.getUserAccountQuotes`](#snaptradetradinggetuseraccountquotes)
59
59
  * [`snaptrade.trading.placeForceOrder`](#snaptradetradingplaceforceorder)
60
- * [`snaptrade.trading.placeOCOOrder`](#snaptradetradingplaceocoorder)
61
60
  * [`snaptrade.trading.placeOrder`](#snaptradetradingplaceorder)
62
61
  * [`snaptrade.transactionsAndReporting.getActivities`](#snaptradetransactionsandreportinggetactivities)
63
62
  * [`snaptrade.transactionsAndReporting.getReportingCustomRange`](#snaptradetransactionsandreportinggetreportingcustomrange)
@@ -179,7 +178,9 @@ main();
179
178
 
180
179
  ### `snaptrade.accountInformation.getAllUserHoldings`<a id="snaptradeaccountinformationgetalluserholdings"></a>
181
180
 
182
- List all accounts for the user, plus balances, positions, and orders for each account.
181
+ Lists balances, positions and orders for the specified account. The data returned is similar to
182
+ the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
183
+
183
184
 
184
185
  #### 🛠️ Usage<a id="🛠️-usage"></a>
185
186
 
@@ -255,7 +256,9 @@ The ID of the account to get balances.
255
256
 
256
257
  ### `snaptrade.accountInformation.getUserAccountDetails`<a id="snaptradeaccountinformationgetuseraccountdetails"></a>
257
258
 
258
- Return details of a specific investment account
259
+ Returns an account object with details for the specified account,
260
+ including the total account market value.
261
+
259
262
 
260
263
  #### 🛠️ Usage<a id="🛠️-usage"></a>
261
264
 
@@ -341,7 +344,7 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
341
344
 
342
345
  ### `snaptrade.accountInformation.getUserAccountPositions`<a id="snaptradeaccountinformationgetuseraccountpositions"></a>
343
346
 
344
- List account positions
347
+ Returns a list of positions in the the specified account.
345
348
 
346
349
  #### 🛠️ Usage<a id="🛠️-usage"></a>
347
350
 
@@ -379,7 +382,10 @@ The ID of the account to get positions.
379
382
 
380
383
  ### `snaptrade.accountInformation.getUserHoldings`<a id="snaptradeaccountinformationgetuserholdings"></a>
381
384
 
382
- List balances, positions and orders for the specified account
385
+ Lists balances, positions and orders for the specified account as well as
386
+ option_positions and account metadata. The data returned is similar to the
387
+ data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
388
+
383
389
 
384
390
  #### 🛠️ Usage<a id="🛠️-usage"></a>
385
391
 
@@ -417,7 +423,7 @@ The ID of the account to fetch holdings for.
417
423
 
418
424
  ### `snaptrade.accountInformation.listUserAccounts`<a id="snaptradeaccountinformationlistuseraccounts"></a>
419
425
 
420
- List accounts
426
+ Get a list of all Account objects for the authenticated SnapTrade user.
421
427
 
422
428
  #### 🛠️ Usage<a id="🛠️-usage"></a>
423
429
 
@@ -450,7 +456,7 @@ const listUserAccountsResponse =
450
456
 
451
457
  ### `snaptrade.accountInformation.updateUserAccount`<a id="snaptradeaccountinformationupdateuseraccount"></a>
452
458
 
453
- Update details of an investment account
459
+ Updates various properties of a specified account.
454
460
 
455
461
  #### 🛠️ Usage<a id="🛠️-usage"></a>
456
462
 
@@ -541,7 +547,9 @@ const deleteSnapTradeUserResponse =
541
547
 
542
548
  ### `snaptrade.authentication.getUserJWT`<a id="snaptradeauthenticationgetuserjwt"></a>
543
549
 
544
- Generate encrypted JWT token
550
+ This API is available to ClientIDs which have opted to use encrypted
551
+ JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
552
+
545
553
 
546
554
  #### 🛠️ Usage<a id="🛠️-usage"></a>
547
555
 
@@ -656,7 +664,9 @@ Sets the version of the connection portal to render, with a default to \\\'v2\\\
656
664
 
657
665
  ### `snaptrade.authentication.registerSnapTradeUser`<a id="snaptradeauthenticationregistersnaptradeuser"></a>
658
666
 
659
- Create SnapTrade user
667
+ Registers a new SnapTrade user under your ClientID.
668
+ Most SnapTrade operations require a user to be passed as a parameter.
669
+
660
670
 
661
671
  #### 🛠️ Usage<a id="🛠️-usage"></a>
662
672
 
@@ -688,7 +698,9 @@ SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as
688
698
 
689
699
  ### `snaptrade.authentication.resetSnapTradeUserSecret`<a id="snaptradeauthenticationresetsnaptradeusersecret"></a>
690
700
 
691
- Obtain a new user secret for a user
701
+ This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
702
+ is comprimised or lost among other reasons.
703
+
692
704
 
693
705
  #### 🛠️ Usage<a id="🛠️-usage"></a>
694
706
 
@@ -1136,7 +1148,7 @@ A currency pair based on currency code for example, {CAD-USD}
1136
1148
 
1137
1149
  ### `snaptrade.referenceData.getPartnerInfo`<a id="snaptradereferencedatagetpartnerinfo"></a>
1138
1150
 
1139
- Get metadata related to Snaptrade partner
1151
+ Returns useful data related to the specified ClientID, including allowed brokerages and data access.
1140
1152
 
1141
1153
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1142
1154
 
@@ -1372,7 +1384,10 @@ const listAllCurrenciesRatesResponse =
1372
1384
 
1373
1385
  ### `snaptrade.referenceData.symbolSearchUserAccount`<a id="snaptradereferencedatasymbolsearchuseraccount"></a>
1374
1386
 
1375
- Search for symbols available in an account
1387
+ Returns a list of universal symbols that are supported by
1388
+ the specificied account. Returned symbols are based on the
1389
+ provided search string, matching on ticker and name.
1390
+
1376
1391
 
1377
1392
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1378
1393
 
@@ -1413,7 +1428,9 @@ The ID of the account to search for symbols within.
1413
1428
 
1414
1429
  ### `snaptrade.trading.cancelUserAccountOrder`<a id="snaptradetradingcanceluseraccountorder"></a>
1415
1430
 
1416
- Cancel open order in account
1431
+ Sends a signal to the brokerage to cancel the specified order.
1432
+ This will only work if the order has not yet been executed.
1433
+
1417
1434
 
1418
1435
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1419
1436
 
@@ -1522,7 +1539,7 @@ Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Goo
1522
1539
 
1523
1540
  ### `snaptrade.trading.getUserAccountQuotes`<a id="snaptradetradinggetuseraccountquotes"></a>
1524
1541
 
1525
- Get symbol quotes
1542
+ Returns live quote(s) from the brokerage for the specified symbol(s).
1526
1543
 
1527
1544
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1528
1545
 
@@ -1635,46 +1652,6 @@ Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Goo
1635
1652
  ---
1636
1653
 
1637
1654
 
1638
- ### `snaptrade.trading.placeOCOOrder`<a id="snaptradetradingplaceocoorder"></a>
1639
-
1640
- Place a OCO (One Cancels Other) order
1641
-
1642
- #### 🛠️ Usage<a id="🛠️-usage"></a>
1643
-
1644
- ```typescript
1645
- const placeOCOOrderResponse = await snaptrade.trading.placeOCOOrder({
1646
- userId: "John.doe@snaptrade.com",
1647
- userSecret: "USERSECRET123",
1648
- });
1649
- ```
1650
-
1651
- #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1652
-
1653
- ##### userId: `string`<a id="userid-string"></a>
1654
-
1655
- ##### userSecret: `string`<a id="usersecret-string"></a>
1656
-
1657
- ##### first_trade_id: `any`<a id="first_trade_id-any"></a>
1658
-
1659
- The ID of first trade object obtained from trade/impact endpoint
1660
-
1661
- ##### second_trade_id: `any`<a id="second_trade_id-any"></a>
1662
-
1663
- The ID of second trade object obtained from trade/impact endpoint
1664
-
1665
- #### 🔄 Return<a id="🔄-return"></a>
1666
-
1667
- [AccountOrderRecord](./models/account-order-record.ts)
1668
-
1669
- #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1670
-
1671
- `/trade/oco` `POST`
1672
-
1673
- [🔙 **Back to Table of Contents**](#table-of-contents)
1674
-
1675
- ---
1676
-
1677
-
1678
1655
  ### `snaptrade.trading.placeOrder`<a id="snaptradetradingplaceorder"></a>
1679
1656
 
1680
1657
  Place order
@@ -13,7 +13,7 @@ import { Position } from '../models';
13
13
  */
14
14
  export declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration) => {
15
15
  /**
16
- *
16
+ * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
17
17
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
18
18
  * @param {string} userId
19
19
  * @param {string} userSecret
@@ -34,7 +34,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
34
34
  */
35
35
  getUserAccountBalance: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
36
  /**
37
- *
37
+ * Returns an account object with details for the specified account, including the total account market value.
38
38
  * @summary Return details of a specific investment account
39
39
  * @param {string} userId
40
40
  * @param {string} userSecret
@@ -56,7 +56,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
56
56
  */
57
57
  getUserAccountOrders: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', days?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
58
58
  /**
59
- *
59
+ * Returns a list of positions in the the specified account.
60
60
  * @summary List account positions
61
61
  * @param {string} userId
62
62
  * @param {string} userSecret
@@ -66,7 +66,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
66
66
  */
67
67
  getUserAccountPositions: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
68
  /**
69
- *
69
+ * Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
70
70
  * @summary List balances, positions and orders for the specified account
71
71
  * @param {string} accountId The ID of the account to fetch holdings for.
72
72
  * @param {string} userId
@@ -76,7 +76,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
76
76
  */
77
77
  getUserHoldings: (accountId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
78
78
  /**
79
- *
79
+ * Get a list of all Account objects for the authenticated SnapTrade user.
80
80
  * @summary List accounts
81
81
  * @param {string} userId
82
82
  * @param {string} userSecret
@@ -85,7 +85,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
85
85
  */
86
86
  listUserAccounts: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
87
87
  /**
88
- *
88
+ * Updates various properties of a specified account.
89
89
  * @summary Update details of an investment account
90
90
  * @param {string} userId
91
91
  * @param {string} userSecret
@@ -101,7 +101,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
101
101
  */
102
102
  export declare const AccountInformationApiFp: (configuration?: Configuration) => {
103
103
  /**
104
- *
104
+ * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
105
105
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
106
106
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
107
107
  * @param {*} [options] Override http request option.
@@ -118,7 +118,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
118
118
  */
119
119
  getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Balance>>>;
120
120
  /**
121
- *
121
+ * Returns an account object with details for the specified account, including the total account market value.
122
122
  * @summary Return details of a specific investment account
123
123
  * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
124
124
  * @param {*} [options] Override http request option.
@@ -134,7 +134,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
134
134
  */
135
135
  getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
136
136
  /**
137
- *
137
+ * Returns a list of positions in the the specified account.
138
138
  * @summary List account positions
139
139
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
140
140
  * @param {*} [options] Override http request option.
@@ -142,7 +142,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
142
142
  */
143
143
  getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Position>>>;
144
144
  /**
145
- *
145
+ * Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
146
146
  * @summary List balances, positions and orders for the specified account
147
147
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
148
148
  * @param {*} [options] Override http request option.
@@ -150,7 +150,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
150
150
  */
151
151
  getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
152
152
  /**
153
- *
153
+ * Get a list of all Account objects for the authenticated SnapTrade user.
154
154
  * @summary List accounts
155
155
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
156
156
  * @param {*} [options] Override http request option.
@@ -158,7 +158,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
158
158
  */
159
159
  listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
160
160
  /**
161
- *
161
+ * Updates various properties of a specified account.
162
162
  * @summary Update details of an investment account
163
163
  * @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
164
164
  * @param {*} [options] Override http request option.
@@ -172,7 +172,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
172
172
  */
173
173
  export declare const AccountInformationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
174
174
  /**
175
- *
175
+ * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
176
176
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
177
177
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
178
178
  * @param {*} [options] Override http request option.
@@ -189,7 +189,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
189
189
  */
190
190
  getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Balance>>;
191
191
  /**
192
- *
192
+ * Returns an account object with details for the specified account, including the total account market value.
193
193
  * @summary Return details of a specific investment account
194
194
  * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
195
195
  * @param {*} [options] Override http request option.
@@ -205,7 +205,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
205
205
  */
206
206
  getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
207
207
  /**
208
- *
208
+ * Returns a list of positions in the the specified account.
209
209
  * @summary List account positions
210
210
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
211
211
  * @param {*} [options] Override http request option.
@@ -213,7 +213,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
213
213
  */
214
214
  getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Position>>;
215
215
  /**
216
- *
216
+ * Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
217
217
  * @summary List balances, positions and orders for the specified account
218
218
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
219
219
  * @param {*} [options] Override http request option.
@@ -221,7 +221,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
221
221
  */
222
222
  getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<AccountHoldingsAccount>;
223
223
  /**
224
- *
224
+ * Get a list of all Account objects for the authenticated SnapTrade user.
225
225
  * @summary List accounts
226
226
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
227
227
  * @param {*} [options] Override http request option.
@@ -229,7 +229,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
229
229
  */
230
230
  listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Account>>;
231
231
  /**
232
- *
232
+ * Updates various properties of a specified account.
233
233
  * @summary Update details of an investment account
234
234
  * @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
235
235
  * @param {*} [options] Override http request option.
@@ -451,7 +451,7 @@ export type AccountInformationApiUpdateUserAccountRequest = {
451
451
  */
452
452
  export declare class AccountInformationApiGenerated extends BaseAPI {
453
453
  /**
454
- *
454
+ * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
455
455
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
456
456
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
457
457
  * @param {*} [options] Override http request option.
@@ -470,7 +470,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
470
470
  */
471
471
  getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance[], any>>;
472
472
  /**
473
- *
473
+ * Returns an account object with details for the specified account, including the total account market value.
474
474
  * @summary Return details of a specific investment account
475
475
  * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
476
476
  * @param {*} [options] Override http request option.
@@ -488,7 +488,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
488
488
  */
489
489
  getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord[], any>>;
490
490
  /**
491
- *
491
+ * Returns a list of positions in the the specified account.
492
492
  * @summary List account positions
493
493
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
494
494
  * @param {*} [options] Override http request option.
@@ -497,7 +497,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
497
497
  */
498
498
  getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Position[], any>>;
499
499
  /**
500
- *
500
+ * Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
501
501
  * @summary List balances, positions and orders for the specified account
502
502
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
503
503
  * @param {*} [options] Override http request option.
@@ -506,7 +506,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
506
506
  */
507
507
  getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldingsAccount, any>>;
508
508
  /**
509
- *
509
+ * Get a list of all Account objects for the authenticated SnapTrade user.
510
510
  * @summary List accounts
511
511
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
512
512
  * @param {*} [options] Override http request option.
@@ -515,7 +515,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
515
515
  */
516
516
  listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any>>;
517
517
  /**
518
- *
518
+ * Updates various properties of a specified account.
519
519
  * @summary Update details of an investment account
520
520
  * @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
521
521
  * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
36
36
  const AccountInformationApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- *
39
+ * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
40
40
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
41
41
  * @param {string} userId
42
42
  * @param {string} userSecret
@@ -147,7 +147,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
147
147
  };
148
148
  }),
149
149
  /**
150
- *
150
+ * Returns an account object with details for the specified account, including the total account market value.
151
151
  * @summary Return details of a specific investment account
152
152
  * @param {string} userId
153
153
  * @param {string} userSecret
@@ -265,7 +265,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
265
265
  };
266
266
  }),
267
267
  /**
268
- *
268
+ * Returns a list of positions in the the specified account.
269
269
  * @summary List account positions
270
270
  * @param {string} userId
271
271
  * @param {string} userSecret
@@ -320,7 +320,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
320
320
  };
321
321
  }),
322
322
  /**
323
- *
323
+ * Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
324
324
  * @summary List balances, positions and orders for the specified account
325
325
  * @param {string} accountId The ID of the account to fetch holdings for.
326
326
  * @param {string} userId
@@ -375,7 +375,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
375
375
  };
376
376
  }),
377
377
  /**
378
- *
378
+ * Get a list of all Account objects for the authenticated SnapTrade user.
379
379
  * @summary List accounts
380
380
  * @param {string} userId
381
381
  * @param {string} userSecret
@@ -426,7 +426,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
426
426
  };
427
427
  }),
428
428
  /**
429
- *
429
+ * Updates various properties of a specified account.
430
430
  * @summary Update details of an investment account
431
431
  * @param {string} userId
432
432
  * @param {string} userSecret
@@ -491,7 +491,7 @@ const AccountInformationApiFp = function (configuration) {
491
491
  const localVarAxiosParamCreator = (0, exports.AccountInformationApiAxiosParamCreator)(configuration);
492
492
  return {
493
493
  /**
494
- *
494
+ * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
495
495
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
496
496
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
497
497
  * @param {*} [options] Override http request option.
@@ -518,7 +518,7 @@ const AccountInformationApiFp = function (configuration) {
518
518
  });
519
519
  },
520
520
  /**
521
- *
521
+ * Returns an account object with details for the specified account, including the total account market value.
522
522
  * @summary Return details of a specific investment account
523
523
  * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
524
524
  * @param {*} [options] Override http request option.
@@ -544,7 +544,7 @@ const AccountInformationApiFp = function (configuration) {
544
544
  });
545
545
  },
546
546
  /**
547
- *
547
+ * Returns a list of positions in the the specified account.
548
548
  * @summary List account positions
549
549
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
550
550
  * @param {*} [options] Override http request option.
@@ -557,7 +557,7 @@ const AccountInformationApiFp = function (configuration) {
557
557
  });
558
558
  },
559
559
  /**
560
- *
560
+ * Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
561
561
  * @summary List balances, positions and orders for the specified account
562
562
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
563
563
  * @param {*} [options] Override http request option.
@@ -570,7 +570,7 @@ const AccountInformationApiFp = function (configuration) {
570
570
  });
571
571
  },
572
572
  /**
573
- *
573
+ * Get a list of all Account objects for the authenticated SnapTrade user.
574
574
  * @summary List accounts
575
575
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
576
576
  * @param {*} [options] Override http request option.
@@ -583,7 +583,7 @@ const AccountInformationApiFp = function (configuration) {
583
583
  });
584
584
  },
585
585
  /**
586
- *
586
+ * Updates various properties of a specified account.
587
587
  * @summary Update details of an investment account
588
588
  * @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
589
589
  * @param {*} [options] Override http request option.
@@ -606,7 +606,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
606
606
  const localVarFp = (0, exports.AccountInformationApiFp)(configuration);
607
607
  return {
608
608
  /**
609
- *
609
+ * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
610
610
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
611
611
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
612
612
  * @param {*} [options] Override http request option.
@@ -627,7 +627,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
627
627
  return localVarFp.getUserAccountBalance(requestParameters, options).then((request) => request(axios, basePath));
628
628
  },
629
629
  /**
630
- *
630
+ * Returns an account object with details for the specified account, including the total account market value.
631
631
  * @summary Return details of a specific investment account
632
632
  * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
633
633
  * @param {*} [options] Override http request option.
@@ -647,7 +647,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
647
647
  return localVarFp.getUserAccountOrders(requestParameters, options).then((request) => request(axios, basePath));
648
648
  },
649
649
  /**
650
- *
650
+ * Returns a list of positions in the the specified account.
651
651
  * @summary List account positions
652
652
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
653
653
  * @param {*} [options] Override http request option.
@@ -657,7 +657,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
657
657
  return localVarFp.getUserAccountPositions(requestParameters, options).then((request) => request(axios, basePath));
658
658
  },
659
659
  /**
660
- *
660
+ * Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
661
661
  * @summary List balances, positions and orders for the specified account
662
662
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
663
663
  * @param {*} [options] Override http request option.
@@ -667,7 +667,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
667
667
  return localVarFp.getUserHoldings(requestParameters, options).then((request) => request(axios, basePath));
668
668
  },
669
669
  /**
670
- *
670
+ * Get a list of all Account objects for the authenticated SnapTrade user.
671
671
  * @summary List accounts
672
672
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
673
673
  * @param {*} [options] Override http request option.
@@ -677,7 +677,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
677
677
  return localVarFp.listUserAccounts(requestParameters, options).then((request) => request(axios, basePath));
678
678
  },
679
679
  /**
680
- *
680
+ * Updates various properties of a specified account.
681
681
  * @summary Update details of an investment account
682
682
  * @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
683
683
  * @param {*} [options] Override http request option.
@@ -697,7 +697,7 @@ exports.AccountInformationApiFactory = AccountInformationApiFactory;
697
697
  */
698
698
  class AccountInformationApiGenerated extends base_1.BaseAPI {
699
699
  /**
700
- *
700
+ * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
701
701
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
702
702
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
703
703
  * @param {*} [options] Override http request option.
@@ -720,7 +720,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
720
720
  return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountBalance(requestParameters, options).then((request) => request(this.axios, this.basePath));
721
721
  }
722
722
  /**
723
- *
723
+ * Returns an account object with details for the specified account, including the total account market value.
724
724
  * @summary Return details of a specific investment account
725
725
  * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
726
726
  * @param {*} [options] Override http request option.
@@ -742,7 +742,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
742
742
  return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountOrders(requestParameters, options).then((request) => request(this.axios, this.basePath));
743
743
  }
744
744
  /**
745
- *
745
+ * Returns a list of positions in the the specified account.
746
746
  * @summary List account positions
747
747
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
748
748
  * @param {*} [options] Override http request option.
@@ -753,7 +753,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
753
753
  return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountPositions(requestParameters, options).then((request) => request(this.axios, this.basePath));
754
754
  }
755
755
  /**
756
- *
756
+ * Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
757
757
  * @summary List balances, positions and orders for the specified account
758
758
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
759
759
  * @param {*} [options] Override http request option.
@@ -764,7 +764,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
764
764
  return (0, exports.AccountInformationApiFp)(this.configuration).getUserHoldings(requestParameters, options).then((request) => request(this.axios, this.basePath));
765
765
  }
766
766
  /**
767
- *
767
+ * Get a list of all Account objects for the authenticated SnapTrade user.
768
768
  * @summary List accounts
769
769
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
770
770
  * @param {*} [options] Override http request option.
@@ -775,7 +775,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
775
775
  return (0, exports.AccountInformationApiFp)(this.configuration).listUserAccounts(requestParameters, options).then((request) => request(this.axios, this.basePath));
776
776
  }
777
777
  /**
778
- *
778
+ * Updates various properties of a specified account.
779
779
  * @summary Update details of an investment account
780
780
  * @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
781
781
  * @param {*} [options] Override http request option.