snaptrade-typescript-sdk 9.0.35 → 9.0.36

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.35-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.35)
+[![npm](https://img.shields.io/badge/npm-v9.0.36-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.36)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -205,7 +205,7 @@ const getAllUserHoldingsResponse =
 
 ##### brokerageAuthorizations: `string`<a id="brokerageauthorizations-string"></a>
 
-Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
+Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -524,7 +524,7 @@ const checkResponse = await snaptrade.apiStatus.check();
 
 ### `snaptrade.authentication.deleteSnapTradeUser`<a id="snaptradeauthenticationdeletesnaptradeuser"></a>
 
-Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
+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.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -554,7 +554,7 @@ const deleteSnapTradeUserResponse =
 
 ### `snaptrade.authentication.listSnapTradeUsers`<a id="snaptradeauthenticationlistsnaptradeusers"></a>
 
-Returns a list of users you've registered over the SnapTrade API.
+Returns a list of all registered user IDs.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -588,7 +588,7 @@ const loginSnapTradeUserResponse =
     customRedirect: "https://snaptrade.com",
     reconnect: "8b5f262d-4bb9-365d-888a-202bd3b15fa1",
     connectionType: "read",
-    connectionPortalVersion: "v2",
+    connectionPortalVersion: "v3",
   });
 ```
 
@@ -600,27 +600,27 @@ const loginSnapTradeUserResponse =
 
 ##### broker: `string`<a id="broker-string"></a>
 
-Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
+Slug of the brokerage to connect the user to. See [the integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=3cfea70ef4254afc89704e47275a7a9a&pvs=4) for a list of supported brokerages and their slugs.
 
 ##### immediateRedirect: `boolean`<a id="immediateredirect-boolean"></a>
 
-When set to True, user will be redirected back to the partner\\\'s site instead of the connection portal
+When set to `true`, user will be redirected back to the partner\\\'s site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
 
 ##### customRedirect: `string`<a id="customredirect-string"></a>
 
-URL to redirect the user to after the user connects their brokerage account
+URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
 
 ##### reconnect: `string`<a id="reconnect-string"></a>
 
-The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
+The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](https://docs.snaptrade.com/docs/fix-broken-connections) for more information.
 
 ##### connectionType: `string`<a id="connectiontype-string"></a>
 
-Sets whether the connection should be read or trade
+Sets whether the connection should be read-only or trade-enabled.
 
 ##### connectionPortalVersion: `string`<a id="connectionportalversion-string"></a>
 
-Sets the version of the connection portal to render, with a default to \\\'v3\\\'
+Sets the version of the connection portal to render.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -671,8 +671,7 @@ SnapTrade User ID. This is chosen by the API partner and can be any string that
 
 ### `snaptrade.authentication.resetSnapTradeUserSecret`<a id="snaptradeauthenticationresetsnaptradeusersecret"></a>
 
-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.
+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.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -693,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 SnapTrade API.
+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)
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -911,11 +910,11 @@ const sessionEventsResponse = await snaptrade.connections.sessionEvents({
 
 ##### userId: `string`<a id="userid-string"></a>
 
-Optional comma seperated list of user IDs used to filter the request on specific users
+Optional comma separated list of user IDs used to filter the request on specific users
 
 ##### sessionId: `string`<a id="sessionid-string"></a>
 
-Optional comma seperated list of session IDs used to filter the request on specific users
+Optional comma separated list of session IDs used to filter the request on specific users
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1751,7 +1750,12 @@ Optional, defaults to true. Determines if a wait is performed to check on order
 
 ### `snaptrade.transactionsAndReporting.getActivities`<a id="snaptradetransactionsandreportinggetactivities"></a>
 
-Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
+Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.
+
+There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
+
+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**.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1764,7 +1768,7 @@ const getActivitiesResponse =
       "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
     brokerageAuthorizations:
       "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
-    type: "DIVIDEND",
+    type: "BUY,SELL,DIVIDEND",
     userId: "snaptrade-user-123",
     userSecret: "USERSECRET123",
   });
@@ -1778,19 +1782,23 @@ const getActivitiesResponse =
 
 ##### startDate: `string | Date`<a id="startdate-string--date"></a>
 
+The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+
 ##### endDate: `string | Date`<a id="enddate-string--date"></a>
 
+The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+
 ##### accounts: `string`<a id="accounts-string"></a>
 
-Optional comma seperated list of account IDs used to filter the request on specific accounts
+Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
 
 ##### brokerageAuthorizations: `string`<a id="brokerageauthorizations-string"></a>
 
-Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
+Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
 
 ##### type: `string`<a id="type-string"></a>
 
-Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
+Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - BUY   - SELL   - DIVIDEND   - CONTRIBUTION   - WITHDRAWAL   - REI   - INTEREST   - FEE 
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1838,7 +1846,7 @@ const getReportingCustomRangeResponse =
 
 ##### accounts: `string`<a id="accounts-string"></a>
 
-Optional comma seperated list of account IDs used to filter the request on specific accounts
+Optional comma separated list of account IDs used to filter the request on specific accounts
 
 ##### detailed: `boolean`<a id="detailed-boolean"></a>
 

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

@@ -17,7 +17,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
      * @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}
@@ -256,7 +256,7 @@ export type AccountInformationApiGetAllUserHoldingsRequest = {
     */
     readonly userSecret: string;
     /**
-    * Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
+    * Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
     * @type {string}
     * @memberof AccountInformationApiGetAllUserHoldings
     */

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}

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}

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

@@ -63,8 +63,8 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      * Returns a list of session events associated with a user.
      * @summary Get all session events for a user
      * @param {string} partnerClientId
-     * @param {string} [userId] Optional comma seperated list of user IDs used to filter the request on specific users
-     * @param {string} [sessionId] Optional comma seperated list of session IDs used to filter the request on specific users
+     * @param {string} [userId] Optional comma separated list of user IDs used to filter the request on specific users
+     * @param {string} [sessionId] Optional comma separated list of session IDs used to filter the request on specific users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -310,13 +310,13 @@ export type ConnectionsApiSessionEventsRequest = {
     */
     readonly partnerClientId: string;
     /**
-    * Optional comma seperated list of user IDs used to filter the request on specific users
+    * Optional comma separated list of user IDs used to filter the request on specific users
     * @type {string}
     * @memberof ConnectionsApiSessionEvents
     */
     readonly userId?: string;
     /**
-    * Optional comma seperated list of session IDs used to filter the request on specific users
+    * Optional comma separated list of session IDs used to filter the request on specific users
     * @type {string}
     * @memberof ConnectionsApiSessionEvents
     */

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

@@ -310,8 +310,8 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
          * Returns a list of session events associated with a user.
          * @summary Get all session events for a user
          * @param {string} partnerClientId
-         * @param {string} [userId] Optional comma seperated list of user IDs used to filter the request on specific users
-         * @param {string} [sessionId] Optional comma seperated list of session IDs used to filter the request on specific users
+         * @param {string} [userId] Optional comma separated list of user IDs used to filter the request on specific users
+         * @param {string} [sessionId] Optional comma separated list of session IDs used to filter the request on specific users
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */