snaptrade-typescript-sdk 9.0.37 → 9.0.39

package/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/npm-v9.0.37-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.37)
+[![npm](https://img.shields.io/badge/npm-v9.0.39-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.39)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -192,7 +192,7 @@ account.
 const getAllUserHoldingsResponse =
   await snaptrade.accountInformation.getAllUserHoldings({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     brokerageAuthorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   });
 ```
@@ -233,7 +233,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 const getUserAccountBalanceResponse =
   await snaptrade.accountInformation.getUserAccountBalance({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   });
 ```
@@ -272,7 +272,7 @@ The data returned here is always cached and refreshed once a day. **If you need
 const getUserAccountDetailsResponse =
   await snaptrade.accountInformation.getUserAccountDetails({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   });
 ```
@@ -311,7 +311,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 const getUserAccountOrdersResponse =
   await snaptrade.accountInformation.getUserAccountOrders({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     state: "all",
     days: 30,
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
@@ -360,7 +360,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 const getUserAccountPositionsResponse =
   await snaptrade.accountInformation.getUserAccountPositions({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   });
 ```
@@ -400,7 +400,7 @@ const getUserHoldingsResponse =
   await snaptrade.accountInformation.getUserHoldings({
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   });
 ```
 
@@ -427,7 +427,7 @@ const getUserHoldingsResponse =
 
 ### `snaptrade.accountInformation.listUserAccounts`<a id="snaptradeaccountinformationlistuseraccounts"></a>
 
-Returns all brokerage accounts known to SnapTrade for the authenticated user.
+Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
 
 The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
 
@@ -438,7 +438,7 @@ The data returned here is always cached and refreshed once a day. **If you need
 const listUserAccountsResponse =
   await snaptrade.accountInformation.listUserAccounts({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   });
 ```
 
@@ -471,7 +471,7 @@ Updates various properties of a specified account.
 const updateUserAccountResponse =
   await snaptrade.accountInformation.updateUserAccount({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "accountId_example",
   });
 ```
@@ -554,7 +554,7 @@ const deleteSnapTradeUserResponse =
 
 ### `snaptrade.authentication.listSnapTradeUsers`<a id="snaptradeauthenticationlistsnaptradeusers"></a>
 
-Returns a list of all registered user IDs.
+Returns a list of all registered user IDs. Please note that the response is not currently paginated.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -582,7 +582,7 @@ Logs in a SnapTrade user and returns an authenticated connection portal URL for
 const loginSnapTradeUserResponse =
   await snaptrade.authentication.loginSnapTradeUser({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     broker: "ALPACA",
     immediateRedirect: true,
     customRedirect: "https://snaptrade.com",
@@ -637,8 +637,8 @@ Sets the version of the connection portal to render.
 
 ### `snaptrade.authentication.registerSnapTradeUser`<a id="snaptradeauthenticationregistersnaptradeuser"></a>
 
-Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
-Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
+Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
+Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -680,7 +680,7 @@ Rotates the secret for a SnapTrade user. You might use this if `userSecret` is c
 const resetSnapTradeUserSecretResponse =
   await snaptrade.authentication.resetSnapTradeUserSecret({
     userId: "snaptrade-user-123",
-    userSecret: "h81@cx1lkalablakwjaltkejraj11=",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   });
 ```
 
@@ -692,7 +692,7 @@ SnapTrade User ID. This is chosen by the API partner and can be any string that
 
 ##### userSecret: `string`<a id="usersecret-string"></a>
 
-SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
+SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -709,16 +709,16 @@ SnapTrade User Secret randomly generated by SnapTrade. This is privileged inform
 
 ### `snaptrade.connections.detailBrokerageAuthorization`<a id="snaptradeconnectionsdetailbrokerageauthorization"></a>
 
-Returns a single brokerage authorization object for the specified ID.
+Returns a single connection for the specified ID.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```typescript
 const detailBrokerageAuthorizationResponse =
   await snaptrade.connections.detailBrokerageAuthorization({
-    authorizationId: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+    authorizationId: "87b24961-b51e-4db8-9226-f198f6518a89",
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   });
 ```
 
@@ -726,8 +726,6 @@ const detailBrokerageAuthorizationResponse =
 
 ##### authorizationId: `string`<a id="authorizationid-string"></a>
 
-The ID of a brokerage authorization object.
-
 ##### userId: `string`<a id="userid-string"></a>
 
 ##### userSecret: `string`<a id="usersecret-string"></a>
@@ -747,16 +745,20 @@ The ID of a brokerage authorization object.
 
 ### `snaptrade.connections.disableBrokerageAuthorization`<a id="snaptradeconnectionsdisablebrokerageauthorization"></a>
 
-Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
+Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections.
+Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.
+
+*Please contact us in order to use this endpoint as it is disabled by default.*
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```typescript
 const disableBrokerageAuthorizationResponse =
   await snaptrade.connections.disableBrokerageAuthorization({
-    authorizationId: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+    authorizationId: "87b24961-b51e-4db8-9226-f198f6518a89",
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   });
 ```
 
@@ -764,8 +766,6 @@ const disableBrokerageAuthorizationResponse =
 
 ##### authorizationId: `string`<a id="authorizationid-string"></a>
 
-The ID of a brokerage authorization object.
-
 ##### userId: `string`<a id="userid-string"></a>
 
 ##### userSecret: `string`<a id="usersecret-string"></a>
@@ -785,7 +785,12 @@ The ID of a brokerage authorization object.
 
 ### `snaptrade.connections.listBrokerageAuthorizations`<a id="snaptradeconnectionslistbrokerageauthorizations"></a>
 
-Returns a list of Brokerage Authorization objects for the user
+Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.
+
+A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.
+
+SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -793,7 +798,7 @@ Returns a list of Brokerage Authorization objects for the user
 const listBrokerageAuthorizationsResponse =
   await snaptrade.connections.listBrokerageAuthorizations({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   });
 ```
 
@@ -818,16 +823,19 @@ const listBrokerageAuthorizationsResponse =
 
 ### `snaptrade.connections.refreshBrokerageAuthorization`<a id="snaptradeconnectionsrefreshbrokerageauthorization"></a>
 
-Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
+Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
+
+*Please contact support for access as this endpoint is not enabled by default.*
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```typescript
 const refreshBrokerageAuthorizationResponse =
   await snaptrade.connections.refreshBrokerageAuthorization({
-    authorizationId: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+    authorizationId: "87b24961-b51e-4db8-9226-f198f6518a89",
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   });
 ```
 
@@ -835,8 +843,6 @@ const refreshBrokerageAuthorizationResponse =
 
 ##### authorizationId: `string`<a id="authorizationid-string"></a>
 
-The ID of a brokerage authorization object.
-
 ##### userId: `string`<a id="userid-string"></a>
 
 ##### userSecret: `string`<a id="usersecret-string"></a>
@@ -856,16 +862,16 @@ The ID of a brokerage authorization object.
 
 ### `snaptrade.connections.removeBrokerageAuthorization`<a id="snaptradeconnectionsremovebrokerageauthorization"></a>
 
-Deletes a specified brokerage authorization given by the ID.
+Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```typescript
 const removeBrokerageAuthorizationResponse =
   await snaptrade.connections.removeBrokerageAuthorization({
-    authorizationId: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+    authorizationId: "87b24961-b51e-4db8-9226-f198f6518a89",
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   });
 ```
 
@@ -873,8 +879,6 @@ const removeBrokerageAuthorizationResponse =
 
 ##### authorizationId: `string`<a id="authorizationid-string"></a>
 
-The ID of the Authorization to delete.
-
 ##### userId: `string`<a id="userid-string"></a>
 
 ##### userSecret: `string`<a id="usersecret-string"></a>
@@ -939,7 +943,7 @@ Creates an option strategy object that will be used to place an option strategy
 ```typescript
 const getOptionStrategyResponse = await snaptrade.options.getOptionStrategy({
   userId: "snaptrade-user-123",
-  userSecret: "USERSECRET123",
+  userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   accountId: "accountId_example",
   underlying_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   legs: [
@@ -991,7 +995,7 @@ Returns the option chain for the specified symbol in the specified account.
 ```typescript
 const getOptionsChainResponse = await snaptrade.options.getOptionsChain({
   userId: "snaptrade-user-123",
-  userSecret: "USERSECRET123",
+  userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   accountId: "accountId_example",
   symbol: "symbol_example",
 });
@@ -1035,7 +1039,7 @@ Returns a Strategy Quotes object which has latest market data of the specified o
 const getOptionsStrategyQuoteResponse =
   await snaptrade.options.getOptionsStrategyQuote({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "accountId_example",
     optionStrategyId: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   });
@@ -1080,7 +1084,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 ```typescript
 const listOptionHoldingsResponse = await snaptrade.options.listOptionHoldings({
   userId: "snaptrade-user-123",
-  userSecret: "USERSECRET123",
+  userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 });
 ```
@@ -1116,7 +1120,7 @@ Places the option strategy order and returns the order record received from the
 const placeOptionStrategyResponse = await snaptrade.options.placeOptionStrategy(
   {
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "2bcd7cc3-e922-4976-bce1-9858296801c3",
     optionStrategyId: "2bcd7cc3-e922-4976-bce1-9858296801c3",
     order_type: "Limit",
@@ -1449,7 +1453,7 @@ provided search string, matching on ticker and name.
 const symbolSearchUserAccountResponse =
   await snaptrade.referenceData.symbolSearchUserAccount({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
     substring: "apple",
   });
@@ -1492,7 +1496,7 @@ This will only work if the order has not yet been executed.
 const cancelUserAccountOrderResponse =
   await snaptrade.trading.cancelUserAccountOrder({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
     brokerage_order_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   });
@@ -1532,7 +1536,7 @@ Return the trade object and it's impact on the account for the specified order.
 ```typescript
 const getOrderImpactResponse = await snaptrade.trading.getOrderImpact({
   userId: "snaptrade-user-123",
-  userSecret: "USERSECRET123",
+  userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   action: "BUY",
   order_type: "Limit",
@@ -1600,7 +1604,7 @@ Returns quote(s) from the brokerage for the specified symbol(s).
 const getUserAccountQuotesResponse =
   await snaptrade.trading.getUserAccountQuotes({
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     symbols: "symbols_example",
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   });
@@ -1646,7 +1650,7 @@ Places a specified trade in the specified account.
 ```typescript
 const placeForceOrderResponse = await snaptrade.trading.placeForceOrder({
   userId: "snaptrade-user-123",
-  userSecret: "USERSECRET123",
+  userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   action: "BUY",
   order_type: "Limit",
@@ -1716,7 +1720,7 @@ returns the status of the order from the brokerage.
 const placeOrderResponse = await snaptrade.trading.placeOrder({
   tradeId: "tradeId_example",
   userId: "snaptrade-user-123",
-  userSecret: "USERSECRET123",
+  userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   wait_to_confirm: true,
 });
 ```
@@ -1770,7 +1774,7 @@ const getActivitiesResponse =
       "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
     type: "BUY,SELL,DIVIDEND",
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   });
 ```
 
@@ -1830,7 +1834,7 @@ const getReportingCustomRangeResponse =
     detailed: true,
     frequency: "monthly",
     userId: "snaptrade-user-123",
-    userSecret: "USERSECRET123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   });
 ```
 

package/dist/api/account-information-api-generated.d.ts

@@ -76,7 +76,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
      */
     getUserHoldings: (accountId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns all brokerage accounts known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+     * Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
      * @summary List accounts
      * @param {string} userId
      * @param {string} userSecret
@@ -150,7 +150,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
      */
     getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
     /**
-     * Returns all brokerage accounts known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+     * Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
      * @summary List accounts
      * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -221,7 +221,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
      */
     getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<AccountHoldingsAccount>;
     /**
-     * Returns all brokerage accounts known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+     * Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
      * @summary List accounts
      * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -506,7 +506,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
      */
     getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldingsAccount, any>>;
     /**
-     * Returns all brokerage accounts known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+     * Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
      * @summary List accounts
      * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/account-information-api-generated.js

@@ -375,7 +375,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns all brokerage accounts known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+         * Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List accounts
          * @param {string} userId
          * @param {string} userSecret
@@ -570,7 +570,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * Returns all brokerage accounts known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+         * Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List accounts
          * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -667,7 +667,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserHoldings(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns all brokerage accounts known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+         * Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List accounts
          * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -764,7 +764,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getUserHoldings(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns all brokerage accounts known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+     * Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
      * @summary List accounts
      * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/authentication-api-generated.d.ts

@@ -20,7 +20,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
      */
     deleteSnapTradeUser: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of all registered user IDs.
+     * Returns a list of all registered user IDs. Please note that the response is not currently paginated.
      * @summary List all users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -37,7 +37,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
      */
     loginSnapTradeUser: (userId: string, userSecret: string, snapTradeLoginUserRequestBody?: SnapTradeLoginUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
+     * Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
      * @summary Register user
      * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
      * @param {*} [options] Override http request option.
@@ -67,7 +67,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
      */
     deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUserResponse>>;
     /**
-     * Returns a list of all registered user IDs.
+     * Returns a list of all registered user IDs. Please note that the response is not currently paginated.
      * @summary List all users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -82,7 +82,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
      */
     loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationLoginSnapTradeUser200Response>>;
     /**
-     * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
+     * Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
      * @summary Register user
      * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -112,7 +112,7 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
      */
     deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteUserResponse>;
     /**
-     * Returns a list of all registered user IDs.
+     * Returns a list of all registered user IDs. Please note that the response is not currently paginated.
      * @summary List all users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -127,7 +127,7 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
      */
     loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<AuthenticationLoginSnapTradeUser200Response>;
     /**
-     * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
+     * Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
      * @summary Register user
      * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -204,7 +204,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
      */
     deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteUserResponse, any>>;
     /**
-     * Returns a list of all registered user IDs.
+     * Returns a list of all registered user IDs. Please note that the response is not currently paginated.
      * @summary List all users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -221,7 +221,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
      */
     loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationLoginSnapTradeUser200Response, any>>;
     /**
-     * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
+     * Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
      * @summary Register user
      * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/authentication-api-generated.js

@@ -81,7 +81,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns a list of all registered user IDs.
+         * Returns a list of all registered user IDs. Please note that the response is not currently paginated.
          * @summary List all users
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -175,7 +175,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
+         * Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
          * @summary Register user
          * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
          * @param {*} [options] Override http request option.
@@ -288,7 +288,7 @@ const AuthenticationApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of all registered user IDs.
+         * Returns a list of all registered user IDs. Please note that the response is not currently paginated.
          * @summary List all users
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -321,7 +321,7 @@ const AuthenticationApiFp = function (configuration) {
             });
         },
         /**
-         * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
+         * Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
          * @summary Register user
          * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -374,7 +374,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of all registered user IDs.
+         * Returns a list of all registered user IDs. Please note that the response is not currently paginated.
          * @summary List all users
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -393,7 +393,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.loginSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
+         * Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
          * @summary Register user
          * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -434,7 +434,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AuthenticationApiFp)(this.configuration).deleteSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns a list of all registered user IDs.
+     * Returns a list of all registered user IDs. Please note that the response is not currently paginated.
      * @summary List all users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -455,7 +455,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AuthenticationApiFp)(this.configuration).loginSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
+     * Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
      * @summary Register user
      * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.