snaptrade-typescript-sdk 9.0.38 → 9.0.40

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

@@ -11,9 +11,9 @@ import { ConnectionsSessionEvents200ResponseInner } from '../models';
  */
 export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Returns a single brokerage authorization object for the specified ID.
-     * @summary Get brokerage authorization details
-     * @param {string} authorizationId The ID of a brokerage authorization object.
+     * Returns a single connection for the specified ID.
+     * @summary Get connection detail
+     * @param {string} authorizationId
      * @param {string} userId
      * @param {string} userSecret
      * @param {*} [options] Override http request option.
@@ -21,9 +21,9 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      */
     detailBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
-     * @summary Manually disable a connection for testing
-     * @param {string} authorizationId The ID of a brokerage authorization object.
+     * Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.*
+     * @summary Force disable connection
+     * @param {string} authorizationId
      * @param {string} userId
      * @param {string} userSecret
      * @param {*} [options] Override http request option.
@@ -31,8 +31,8 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      */
     disableBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of Brokerage Authorization objects for the user
-     * @summary List all brokerage authorizations for the User
+     * Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+     * @summary List all connections
      * @param {string} userId
      * @param {string} userSecret
      * @param {*} [options] Override http request option.
@@ -40,9 +40,9 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      */
     listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
+     * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.  *Please contact support for access as this endpoint is not enabled by default.*
      * @summary Refresh holdings for a connection
-     * @param {string} authorizationId The ID of a brokerage authorization object.
+     * @param {string} authorizationId
      * @param {string} userId
      * @param {string} userSecret
      * @param {*} [options] Override http request option.
@@ -50,9 +50,9 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      */
     refreshBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Deletes a specified brokerage authorization given by the ID.
-     * @summary Delete brokerage authorization
-     * @param {string} authorizationId The ID of the Authorization to delete.
+     * Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+     * @summary Delete connection
+     * @param {string} authorizationId
      * @param {string} userId
      * @param {string} userSecret
      * @param {*} [options] Override http request option.
@@ -76,31 +76,31 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
  */
 export declare const ConnectionsApiFp: (configuration?: Configuration) => {
     /**
-     * Returns a single brokerage authorization object for the specified ID.
-     * @summary Get brokerage authorization details
+     * Returns a single connection for the specified ID.
+     * @summary Get connection detail
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorization>>;
     /**
-     * Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
-     * @summary Manually disable a connection for testing
+     * Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.*
+     * @summary Force disable connection
      * @param {ConnectionsApiDisableBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     disableBrokerageAuthorization(requestParameters: ConnectionsApiDisableBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorizationDisabledConfirmation>>;
     /**
-     * Returns a list of Brokerage Authorization objects for the user
-     * @summary List all brokerage authorizations for the User
+     * Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+     * @summary List all connections
      * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
     /**
-     * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
+     * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.  *Please contact support for access as this endpoint is not enabled by default.*
      * @summary Refresh holdings for a connection
      * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -108,8 +108,8 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
      */
     refreshBrokerageAuthorization(requestParameters: ConnectionsApiRefreshBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorizationRefreshConfirmation>>;
     /**
-     * Deletes a specified brokerage authorization given by the ID.
-     * @summary Delete brokerage authorization
+     * Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+     * @summary Delete connection
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -130,31 +130,31 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
  */
 export declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Returns a single brokerage authorization object for the specified ID.
-     * @summary Get brokerage authorization details
+     * Returns a single connection for the specified ID.
+     * @summary Get connection detail
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorization>;
     /**
-     * Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
-     * @summary Manually disable a connection for testing
+     * Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.*
+     * @summary Force disable connection
      * @param {ConnectionsApiDisableBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     disableBrokerageAuthorization(requestParameters: ConnectionsApiDisableBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorizationDisabledConfirmation>;
     /**
-     * Returns a list of Brokerage Authorization objects for the user
-     * @summary List all brokerage authorizations for the User
+     * Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+     * @summary List all connections
      * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
     /**
-     * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
+     * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.  *Please contact support for access as this endpoint is not enabled by default.*
      * @summary Refresh holdings for a connection
      * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -162,8 +162,8 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
      */
     refreshBrokerageAuthorization(requestParameters: ConnectionsApiRefreshBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorizationRefreshConfirmation>;
     /**
-     * Deletes a specified brokerage authorization given by the ID.
-     * @summary Delete brokerage authorization
+     * Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+     * @summary Delete connection
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -185,7 +185,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
  */
 export type ConnectionsApiDetailBrokerageAuthorizationRequest = {
     /**
-    * The ID of a brokerage authorization object.
+    *
     * @type {string}
     * @memberof ConnectionsApiDetailBrokerageAuthorization
     */
@@ -210,7 +210,7 @@ export type ConnectionsApiDetailBrokerageAuthorizationRequest = {
  */
 export type ConnectionsApiDisableBrokerageAuthorizationRequest = {
     /**
-    * The ID of a brokerage authorization object.
+    *
     * @type {string}
     * @memberof ConnectionsApiDisableBrokerageAuthorization
     */
@@ -254,7 +254,7 @@ export type ConnectionsApiListBrokerageAuthorizationsRequest = {
  */
 export type ConnectionsApiRefreshBrokerageAuthorizationRequest = {
     /**
-    * The ID of a brokerage authorization object.
+    *
     * @type {string}
     * @memberof ConnectionsApiRefreshBrokerageAuthorization
     */
@@ -279,7 +279,7 @@ export type ConnectionsApiRefreshBrokerageAuthorizationRequest = {
  */
 export type ConnectionsApiRemoveBrokerageAuthorizationRequest = {
     /**
-    * The ID of the Authorization to delete.
+    *
     * @type {string}
     * @memberof ConnectionsApiRemoveBrokerageAuthorization
     */
@@ -330,8 +330,8 @@ export type ConnectionsApiSessionEventsRequest = {
  */
 export declare class ConnectionsApiGenerated extends BaseAPI {
     /**
-     * Returns a single brokerage authorization object for the specified ID.
-     * @summary Get brokerage authorization details
+     * Returns a single connection for the specified ID.
+     * @summary Get connection detail
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -339,8 +339,8 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
      */
     detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization, any>>;
     /**
-     * Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
-     * @summary Manually disable a connection for testing
+     * Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.*
+     * @summary Force disable connection
      * @param {ConnectionsApiDisableBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -348,8 +348,8 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
      */
     disableBrokerageAuthorization(requestParameters: ConnectionsApiDisableBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationDisabledConfirmation, any>>;
     /**
-     * Returns a list of Brokerage Authorization objects for the user
-     * @summary List all brokerage authorizations for the User
+     * Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+     * @summary List all connections
      * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -357,7 +357,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
      */
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any>>;
     /**
-     * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
+     * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.  *Please contact support for access as this endpoint is not enabled by default.*
      * @summary Refresh holdings for a connection
      * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -366,8 +366,8 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
      */
     refreshBrokerageAuthorization(requestParameters: ConnectionsApiRefreshBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationRefreshConfirmation, any>>;
     /**
-     * Deletes a specified brokerage authorization given by the ID.
-     * @summary Delete brokerage authorization
+     * Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+     * @summary Delete connection
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

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

@@ -36,9 +36,9 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
 const ConnectionsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Returns a single brokerage authorization object for the specified ID.
-         * @summary Get brokerage authorization details
-         * @param {string} authorizationId The ID of a brokerage authorization object.
+         * Returns a single connection for the specified ID.
+         * @summary Get connection detail
+         * @param {string} authorizationId
          * @param {string} userId
          * @param {string} userSecret
          * @param {*} [options] Override http request option.
@@ -91,9 +91,9 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
-         * @summary Manually disable a connection for testing
-         * @param {string} authorizationId The ID of a brokerage authorization object.
+         * Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.*
+         * @summary Force disable connection
+         * @param {string} authorizationId
          * @param {string} userId
          * @param {string} userSecret
          * @param {*} [options] Override http request option.
@@ -146,8 +146,8 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns a list of Brokerage Authorization objects for the user
-         * @summary List all brokerage authorizations for the User
+         * Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+         * @summary List all connections
          * @param {string} userId
          * @param {string} userSecret
          * @param {*} [options] Override http request option.
@@ -197,9 +197,9 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
+         * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.  *Please contact support for access as this endpoint is not enabled by default.*
          * @summary Refresh holdings for a connection
-         * @param {string} authorizationId The ID of a brokerage authorization object.
+         * @param {string} authorizationId
          * @param {string} userId
          * @param {string} userSecret
          * @param {*} [options] Override http request option.
@@ -252,9 +252,9 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Deletes a specified brokerage authorization given by the ID.
-         * @summary Delete brokerage authorization
-         * @param {string} authorizationId The ID of the Authorization to delete.
+         * Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+         * @summary Delete connection
+         * @param {string} authorizationId
          * @param {string} userId
          * @param {string} userSecret
          * @param {*} [options] Override http request option.
@@ -370,8 +370,8 @@ const ConnectionsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.ConnectionsApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Returns a single brokerage authorization object for the specified ID.
-         * @summary Get brokerage authorization details
+         * Returns a single connection for the specified ID.
+         * @summary Get connection detail
          * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -383,8 +383,8 @@ const ConnectionsApiFp = function (configuration) {
             });
         },
         /**
-         * Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
-         * @summary Manually disable a connection for testing
+         * Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.*
+         * @summary Force disable connection
          * @param {ConnectionsApiDisableBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -396,8 +396,8 @@ const ConnectionsApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of Brokerage Authorization objects for the user
-         * @summary List all brokerage authorizations for the User
+         * Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+         * @summary List all connections
          * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -409,7 +409,7 @@ const ConnectionsApiFp = function (configuration) {
             });
         },
         /**
-         * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
+         * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.  *Please contact support for access as this endpoint is not enabled by default.*
          * @summary Refresh holdings for a connection
          * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -422,8 +422,8 @@ const ConnectionsApiFp = function (configuration) {
             });
         },
         /**
-         * Deletes a specified brokerage authorization given by the ID.
-         * @summary Delete brokerage authorization
+         * Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+         * @summary Delete connection
          * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -458,8 +458,8 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.ConnectionsApiFp)(configuration);
     return {
         /**
-         * Returns a single brokerage authorization object for the specified ID.
-         * @summary Get brokerage authorization details
+         * Returns a single connection for the specified ID.
+         * @summary Get connection detail
          * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -468,8 +468,8 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.detailBrokerageAuthorization(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
-         * @summary Manually disable a connection for testing
+         * Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.*
+         * @summary Force disable connection
          * @param {ConnectionsApiDisableBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -478,8 +478,8 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.disableBrokerageAuthorization(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of Brokerage Authorization objects for the user
-         * @summary List all brokerage authorizations for the User
+         * Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+         * @summary List all connections
          * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -488,7 +488,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listBrokerageAuthorizations(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
+         * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.  *Please contact support for access as this endpoint is not enabled by default.*
          * @summary Refresh holdings for a connection
          * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -498,8 +498,8 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.refreshBrokerageAuthorization(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Deletes a specified brokerage authorization given by the ID.
-         * @summary Delete brokerage authorization
+         * Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+         * @summary Delete connection
          * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -528,8 +528,8 @@ exports.ConnectionsApiFactory = ConnectionsApiFactory;
  */
 class ConnectionsApiGenerated extends base_1.BaseAPI {
     /**
-     * Returns a single brokerage authorization object for the specified ID.
-     * @summary Get brokerage authorization details
+     * Returns a single connection for the specified ID.
+     * @summary Get connection detail
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -539,8 +539,8 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.ConnectionsApiFp)(this.configuration).detailBrokerageAuthorization(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
-     * @summary Manually disable a connection for testing
+     * Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.*
+     * @summary Force disable connection
      * @param {ConnectionsApiDisableBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -550,8 +550,8 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.ConnectionsApiFp)(this.configuration).disableBrokerageAuthorization(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns a list of Brokerage Authorization objects for the user
-     * @summary List all brokerage authorizations for the User
+     * Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+     * @summary List all connections
      * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -561,7 +561,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.ConnectionsApiFp)(this.configuration).listBrokerageAuthorizations(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
+     * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.  *Please contact support for access as this endpoint is not enabled by default.*
      * @summary Refresh holdings for a connection
      * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -572,8 +572,8 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.ConnectionsApiFp)(this.configuration).refreshBrokerageAuthorization(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Deletes a specified brokerage authorization given by the ID.
-     * @summary Delete brokerage authorization
+     * Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+     * @summary Delete connection
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}