snaptrade-typescript-sdk 9.0.34 → 9.0.36

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

@@ -40,7 +40,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
          * @summary List all accounts for the user, plus balances, positions, and orders for each account.
          * @param {string} userId
          * @param {string} userSecret
-         * @param {string} [brokerageAuthorizations] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
+         * @param {string} [brokerageAuthorizations] Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
          * @param {*} [options] Override http request option.
          * @deprecated
          * @throws {RequiredError}
@@ -92,11 +92,11 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * A list of account balances for the specified account (one per currency that the account holds).
+         * Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List account balances
          * @param {string} userId
          * @param {string} userSecret
-         * @param {string} accountId The ID of the account to get balances.
+         * @param {string} accountId
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -147,11 +147,11 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns an account object with details for the specified account, including the total account market value.
-         * @summary Return details of a specific investment account
+         * Returns account detail known to SnapTrade for the specified account.  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 Get account detail
          * @param {string} userId
          * @param {string} userSecret
-         * @param {string} accountId The ID of the account to get detail of.
+         * @param {string} accountId
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -202,11 +202,11 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Fetch all recent orders from a user\'s account.
-         * @summary List account orders
+         * Returns a list of recent orders in the specified account.  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+         * @summary List account recent orders
          * @param {string} userId
          * @param {string} userSecret
-         * @param {string} accountId The ID of the account to get orders.
+         * @param {string} accountId
          * @param {'all' | 'open' | 'executed'} [state] defaults value is set to \"all\"
          * @param {number} [days] Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.
          * @param {*} [options] Override http request option.
@@ -265,11 +265,11 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns a list of positions in the specified account.
+         * Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List account positions
          * @param {string} userId
          * @param {string} userSecret
-         * @param {string} accountId The ID of the account to get positions.
+         * @param {string} accountId
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -320,7 +320,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+         * Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List account holdings
          * @param {string} accountId
          * @param {string} userId
@@ -375,7 +375,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Get a list of all Account objects for the authenticated SnapTrade user.
+         * 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**.
          * @summary List accounts
          * @param {string} userId
          * @param {string} userSecret
@@ -505,7 +505,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * A list of account balances for the specified account (one per currency that the account holds).
+         * Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List account balances
          * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -518,8 +518,8 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * Returns an account object with details for the specified account, including the total account market value.
-         * @summary Return details of a specific investment account
+         * Returns account detail known to SnapTrade for the specified account.  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 Get account detail
          * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -531,8 +531,8 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * Fetch all recent orders from a user\'s account.
-         * @summary List account orders
+         * Returns a list of recent orders in the specified account.  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+         * @summary List account recent orders
          * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -544,7 +544,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of positions in the specified account.
+         * Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List account positions
          * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -557,7 +557,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+         * Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List account holdings
          * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -570,7 +570,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * Get a list of all Account objects for the authenticated SnapTrade user.
+         * 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**.
          * @summary List accounts
          * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -617,7 +617,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getAllUserHoldings(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * A list of account balances for the specified account (one per currency that the account holds).
+         * Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List account balances
          * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -627,8 +627,8 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserAccountBalance(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns an account object with details for the specified account, including the total account market value.
-         * @summary Return details of a specific investment account
+         * Returns account detail known to SnapTrade for the specified account.  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 Get account detail
          * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -637,8 +637,8 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserAccountDetails(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Fetch all recent orders from a user\'s account.
-         * @summary List account orders
+         * Returns a list of recent orders in the specified account.  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+         * @summary List account recent orders
          * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -647,7 +647,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserAccountOrders(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of positions in the specified account.
+         * Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List account positions
          * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -657,7 +657,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserAccountPositions(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+         * Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
          * @summary List account holdings
          * @param {AccountInformationApiGetUserHoldingsRequest} 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));
         },
         /**
-         * Get a list of all Account objects for the authenticated SnapTrade user.
+         * 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**.
          * @summary List accounts
          * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -709,7 +709,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getAllUserHoldings(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * A list of account balances for the specified account (one per currency that the account holds).
+     * Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
      * @summary List account balances
      * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -720,8 +720,8 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountBalance(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns an account object with details for the specified account, including the total account market value.
-     * @summary Return details of a specific investment account
+     * Returns account detail known to SnapTrade for the specified account.  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 Get account detail
      * @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -731,8 +731,8 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountDetails(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Fetch all recent orders from a user\'s account.
-     * @summary List account orders
+     * Returns a list of recent orders in the specified account.  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+     * @summary List account recent orders
      * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -742,7 +742,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountOrders(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns a list of positions in the specified account.
+     * Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
      * @summary List account positions
      * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -753,7 +753,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountPositions(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+     * Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
      * @summary List account holdings
      * @param {AccountInformationApiGetUserHoldingsRequest} 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));
     }
     /**
-     * Get a list of all Account objects for the authenticated SnapTrade user.
+     * 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**.
      * @summary List accounts
      * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -12,16 +12,16 @@ import { UserIDandSecret } from '../models';
  */
 export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
-     * @summary Delete SnapTrade user
+     * Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
+     * @summary Delete user
      * @param {string} userId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     deleteSnapTradeUser: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of users you\'ve registered over the SnapTrade API.
-     * @summary List SnapTrade users
+     * Returns a list of all registered user IDs.
+     * @summary List all users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -38,15 +38,15 @@ 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.
-     * @summary Create SnapTrade user
+     * @summary Register user
      * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     registerSnapTradeUser: (snapTradeRegisterUserRequestBody: SnapTradeRegisterUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
-     * @summary Obtain a new user secret for a user
+     * Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
+     * @summary Rotate user secret
      * @param {UserIDandSecret} userIDandSecret
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -59,16 +59,16 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
  */
 export declare const AuthenticationApiFp: (configuration?: Configuration) => {
     /**
-     * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
-     * @summary Delete SnapTrade user
+     * Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
+     * @summary Delete user
      * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUserResponse>>;
     /**
-     * Returns a list of users you\'ve registered over the SnapTrade API.
-     * @summary List SnapTrade users
+     * Returns a list of all registered user IDs.
+     * @summary List all users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -83,15 +83,15 @@ 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.
-     * @summary Create SnapTrade user
+     * @summary Register user
      * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserIDandSecret>>;
     /**
-     * This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
-     * @summary Obtain a new user secret for a user
+     * Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
+     * @summary Rotate user secret
      * @param {AuthenticationApiResetSnapTradeUserSecretRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -104,16 +104,16 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
  */
 export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
-     * @summary Delete SnapTrade user
+     * Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
+     * @summary Delete user
      * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteUserResponse>;
     /**
-     * Returns a list of users you\'ve registered over the SnapTrade API.
-     * @summary List SnapTrade users
+     * Returns a list of all registered user IDs.
+     * @summary List all users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -128,15 +128,15 @@ 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.
-     * @summary Create SnapTrade user
+     * @summary Register user
      * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<UserIDandSecret>;
     /**
-     * This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
-     * @summary Obtain a new user secret for a user
+     * Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
+     * @summary Rotate user secret
      * @param {AuthenticationApiResetSnapTradeUserSecretRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -195,8 +195,8 @@ export type AuthenticationApiResetSnapTradeUserSecretRequest = {} & UserIDandSec
  */
 export declare class AuthenticationApiGenerated extends BaseAPI {
     /**
-     * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
-     * @summary Delete SnapTrade user
+     * Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
+     * @summary Delete user
      * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -204,8 +204,8 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
      */
     deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteUserResponse, any>>;
     /**
-     * Returns a list of users you\'ve registered over the SnapTrade API.
-     * @summary List SnapTrade users
+     * Returns a list of all registered user IDs.
+     * @summary List all users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AuthenticationApiGenerated
@@ -222,7 +222,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.
-     * @summary Create SnapTrade user
+     * @summary Register user
      * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -230,8 +230,8 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
      */
     registerSnapTradeUser(requestParameters: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserIDandSecret, any>>;
     /**
-     * This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
-     * @summary Obtain a new user secret for a user
+     * Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
+     * @summary Rotate user secret
      * @param {AuthenticationApiResetSnapTradeUserSecretRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

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

@@ -36,8 +36,8 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
 const AuthenticationApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
-         * @summary Delete SnapTrade user
+         * Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
+         * @summary Delete user
          * @param {string} userId
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -81,8 +81,8 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns a list of users you\'ve registered over the SnapTrade API.
-         * @summary List SnapTrade users
+         * Returns a list of all registered user IDs.
+         * @summary List all users
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -176,7 +176,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.
-         * @summary Create SnapTrade user
+         * @summary Register user
          * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -220,8 +220,8 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
-         * @summary Obtain a new user secret for a user
+         * Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
+         * @summary Rotate user secret
          * @param {UserIDandSecret} userIDandSecret
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -275,8 +275,8 @@ const AuthenticationApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.AuthenticationApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
-         * @summary Delete SnapTrade user
+         * Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
+         * @summary Delete user
          * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -288,8 +288,8 @@ const AuthenticationApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of users you\'ve registered over the SnapTrade API.
-         * @summary List SnapTrade users
+         * Returns a list of all registered user IDs.
+         * @summary List all users
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -322,7 +322,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.
-         * @summary Create SnapTrade user
+         * @summary Register user
          * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -337,8 +337,8 @@ const AuthenticationApiFp = function (configuration) {
             });
         },
         /**
-         * This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
-         * @summary Obtain a new user secret for a user
+         * Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
+         * @summary Rotate user secret
          * @param {AuthenticationApiResetSnapTradeUserSecretRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -364,8 +364,8 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.AuthenticationApiFp)(configuration);
     return {
         /**
-         * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
-         * @summary Delete SnapTrade user
+         * Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
+         * @summary Delete user
          * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -374,8 +374,8 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of users you\'ve registered over the SnapTrade API.
-         * @summary List SnapTrade users
+         * Returns a list of all registered user IDs.
+         * @summary List all users
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -394,7 +394,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
         },
         /**
          * 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.
-         * @summary Create SnapTrade user
+         * @summary Register user
          * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -403,8 +403,8 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.registerSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
-         * @summary Obtain a new user secret for a user
+         * Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
+         * @summary Rotate user secret
          * @param {AuthenticationApiResetSnapTradeUserSecretRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -423,8 +423,8 @@ exports.AuthenticationApiFactory = AuthenticationApiFactory;
  */
 class AuthenticationApiGenerated extends base_1.BaseAPI {
     /**
-     * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
-     * @summary Delete SnapTrade user
+     * Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
+     * @summary Delete user
      * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -434,8 +434,8 @@ 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 users you\'ve registered over the SnapTrade API.
-     * @summary List SnapTrade users
+     * Returns a list of all registered user IDs.
+     * @summary List all users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AuthenticationApiGenerated
@@ -456,7 +456,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
     }
     /**
      * 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.
-     * @summary Create SnapTrade user
+     * @summary Register user
      * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -466,8 +466,8 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AuthenticationApiFp)(this.configuration).registerSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
-     * @summary Obtain a new user secret for a user
+     * Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
+     * @summary Rotate user secret
      * @param {AuthenticationApiResetSnapTradeUserSecretRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}