snaptrade-typescript-sdk 9.0.199 → 10.0.1

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

@@ -1,576 +0,0 @@
-import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { Configuration } from '../configuration';
-import { RequestArgs, BaseAPI } from '../base';
-import { Account } from '../models';
-import { BrokerageAuthorization } from '../models';
-import { BrokerageAuthorizationDisabledConfirmation } from '../models';
-import { BrokerageAuthorizationRefreshConfirmation } from '../models';
-import { ConnectionsSessionEvents200ResponseInner } from '../models';
-import { DeleteConnectionConfirmation } from '../models';
-import { RateOfReturnResponse } from '../models';
-/**
- * ConnectionsApi - axios parameter creator
- * @export
- */
-export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
-     * @summary Delete connection
-     * @param {string} connectionId
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteConnection: (connectionId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * 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.
-     * @throws {RequiredError}
-     */
-    detailBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * 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](/docs/webhooks#webhooks-connection_broken) for the connection.  This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support 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.
-     * @throws {RequiredError}
-     */
-    disableBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Returns all brokerage accounts that belong to the specified connection for the authenticated user.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
-     * @summary List accounts for a connection
-     * @param {string} authorizationId
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listBrokerageAuthorizationAccounts: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * 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.
-     * @throws {RequiredError}
-     */
-    listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.  **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
-     * @summary Refresh holdings for a connection
-     * @param {string} authorizationId
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    refreshBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
-     * @summary Delete connection
-     * @param {string} authorizationId
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    removeBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Returns a list of rate of return percents for a given connection.
-     * @summary List connection rate of returns
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {string} authorizationId
-     * @param {string} [timeframes] Optional comma separated list of rate-of-return timeframes to return. Supported values are &#x60;ALL&#x60;, &#x60;1Y&#x60;, &#x60;YTD&#x60;, &#x60;1M&#x60;, &#x60;1W&#x60;, and &#x60;1D&#x60;. If omitted, SnapTrade returns all six supported timeframes.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    returnRates: (userId: string, userSecret: string, authorizationId: string, timeframes?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * 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 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}
-     */
-    sessionEvents: (partnerClientId: string, userId?: string, sessionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * ConnectionsApi - functional programming interface
- * @export
- */
-export declare const ConnectionsApiFp: (configuration?: Configuration) => {
-    /**
-     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
-     * @summary Delete connection
-     * @param {ConnectionsApiDeleteConnectionRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteConnection(requestParameters: ConnectionsApiDeleteConnectionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteConnectionConfirmation>>;
-    /**
-     * 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 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](/docs/webhooks#webhooks-connection_broken) for the connection.  This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support 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 all brokerage accounts that belong to the specified connection for the authenticated user.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
-     * @summary List accounts for a connection
-     * @param {ConnectionsApiListBrokerageAuthorizationAccountsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listBrokerageAuthorizationAccounts(requestParameters: ConnectionsApiListBrokerageAuthorizationAccountsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
-    /**
-     * 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 connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.  **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
-     * @summary Refresh holdings for a connection
-     * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    refreshBrokerageAuthorization(requestParameters: ConnectionsApiRefreshBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorizationRefreshConfirmation>>;
-    /**
-     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
-     * @summary Delete connection
-     * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Returns a list of rate of return percents for a given connection.
-     * @summary List connection rate of returns
-     * @param {ConnectionsApiReturnRatesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    returnRates(requestParameters: ConnectionsApiReturnRatesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RateOfReturnResponse>>;
-    /**
-     * Returns a list of session events associated with a user.
-     * @summary Get all session events for a user
-     * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>>;
-};
-/**
- * ConnectionsApi - factory interface
- * @export
- */
-export declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
-     * @summary Delete connection
-     * @param {ConnectionsApiDeleteConnectionRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteConnection(requestParameters: ConnectionsApiDeleteConnectionRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteConnectionConfirmation>;
-    /**
-     * 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 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](/docs/webhooks#webhooks-connection_broken) for the connection.  This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support 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 all brokerage accounts that belong to the specified connection for the authenticated user.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
-     * @summary List accounts for a connection
-     * @param {ConnectionsApiListBrokerageAuthorizationAccountsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listBrokerageAuthorizationAccounts(requestParameters: ConnectionsApiListBrokerageAuthorizationAccountsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Account>>;
-    /**
-     * 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 connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.  **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
-     * @summary Refresh holdings for a connection
-     * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    refreshBrokerageAuthorization(requestParameters: ConnectionsApiRefreshBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorizationRefreshConfirmation>;
-    /**
-     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
-     * @summary Delete connection
-     * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Returns a list of rate of return percents for a given connection.
-     * @summary List connection rate of returns
-     * @param {ConnectionsApiReturnRatesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    returnRates(requestParameters: ConnectionsApiReturnRatesRequest, options?: AxiosRequestConfig): AxiosPromise<RateOfReturnResponse>;
-    /**
-     * Returns a list of session events associated with a user.
-     * @summary Get all session events for a user
-     * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>;
-};
-/**
- * Request parameters for deleteConnection operation in ConnectionsApi.
- * @export
- * @interface ConnectionsApiDeleteConnectionRequest
- */
-export type ConnectionsApiDeleteConnectionRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiDeleteConnection
-    */
-    readonly connectionId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiDeleteConnection
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiDeleteConnection
-    */
-    readonly userSecret: string;
-};
-/**
- * Request parameters for detailBrokerageAuthorization operation in ConnectionsApi.
- * @export
- * @interface ConnectionsApiDetailBrokerageAuthorizationRequest
- */
-export type ConnectionsApiDetailBrokerageAuthorizationRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiDetailBrokerageAuthorization
-    */
-    readonly authorizationId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiDetailBrokerageAuthorization
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiDetailBrokerageAuthorization
-    */
-    readonly userSecret: string;
-};
-/**
- * Request parameters for disableBrokerageAuthorization operation in ConnectionsApi.
- * @export
- * @interface ConnectionsApiDisableBrokerageAuthorizationRequest
- */
-export type ConnectionsApiDisableBrokerageAuthorizationRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiDisableBrokerageAuthorization
-    */
-    readonly authorizationId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiDisableBrokerageAuthorization
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiDisableBrokerageAuthorization
-    */
-    readonly userSecret: string;
-};
-/**
- * Request parameters for listBrokerageAuthorizationAccounts operation in ConnectionsApi.
- * @export
- * @interface ConnectionsApiListBrokerageAuthorizationAccountsRequest
- */
-export type ConnectionsApiListBrokerageAuthorizationAccountsRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiListBrokerageAuthorizationAccounts
-    */
-    readonly authorizationId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiListBrokerageAuthorizationAccounts
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiListBrokerageAuthorizationAccounts
-    */
-    readonly userSecret: string;
-};
-/**
- * Request parameters for listBrokerageAuthorizations operation in ConnectionsApi.
- * @export
- * @interface ConnectionsApiListBrokerageAuthorizationsRequest
- */
-export type ConnectionsApiListBrokerageAuthorizationsRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiListBrokerageAuthorizations
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiListBrokerageAuthorizations
-    */
-    readonly userSecret: string;
-};
-/**
- * Request parameters for refreshBrokerageAuthorization operation in ConnectionsApi.
- * @export
- * @interface ConnectionsApiRefreshBrokerageAuthorizationRequest
- */
-export type ConnectionsApiRefreshBrokerageAuthorizationRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiRefreshBrokerageAuthorization
-    */
-    readonly authorizationId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiRefreshBrokerageAuthorization
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiRefreshBrokerageAuthorization
-    */
-    readonly userSecret: string;
-};
-/**
- * Request parameters for removeBrokerageAuthorization operation in ConnectionsApi.
- * @export
- * @interface ConnectionsApiRemoveBrokerageAuthorizationRequest
- */
-export type ConnectionsApiRemoveBrokerageAuthorizationRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiRemoveBrokerageAuthorization
-    */
-    readonly authorizationId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiRemoveBrokerageAuthorization
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiRemoveBrokerageAuthorization
-    */
-    readonly userSecret: string;
-};
-/**
- * Request parameters for returnRates operation in ConnectionsApi.
- * @export
- * @interface ConnectionsApiReturnRatesRequest
- */
-export type ConnectionsApiReturnRatesRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiReturnRates
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiReturnRates
-    */
-    readonly userSecret: string;
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiReturnRates
-    */
-    readonly authorizationId: string;
-    /**
-    * Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
-    * @type {string}
-    * @memberof ConnectionsApiReturnRates
-    */
-    readonly timeframes?: string;
-};
-/**
- * Request parameters for sessionEvents operation in ConnectionsApi.
- * @export
- * @interface ConnectionsApiSessionEventsRequest
- */
-export type ConnectionsApiSessionEventsRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof ConnectionsApiSessionEvents
-    */
-    readonly partnerClientId: string;
-    /**
-    * Optional comma separated list of user IDs used to filter the request on specific users
-    * @type {string}
-    * @memberof ConnectionsApiSessionEvents
-    */
-    readonly userId?: string;
-    /**
-    * Optional comma separated list of session IDs used to filter the request on specific users
-    * @type {string}
-    * @memberof ConnectionsApiSessionEvents
-    */
-    readonly sessionId?: string;
-};
-/**
- * ConnectionsApiGenerated - object-oriented interface
- * @export
- * @class ConnectionsApiGenerated
- * @extends {BaseAPI}
- */
-export declare class ConnectionsApiGenerated extends BaseAPI {
-    /**
-     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
-     * @summary Delete connection
-     * @param {ConnectionsApiDeleteConnectionRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ConnectionsApiGenerated
-     */
-    deleteConnection(requestParameters: ConnectionsApiDeleteConnectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteConnectionConfirmation, any, {}>>;
-    /**
-     * 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}
-     * @memberof ConnectionsApiGenerated
-     */
-    detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization, any, {}>>;
-    /**
-     * 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](/docs/webhooks#webhooks-connection_broken) for the connection.  This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default.
-     * @summary Force disable connection
-     * @param {ConnectionsApiDisableBrokerageAuthorizationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ConnectionsApiGenerated
-     */
-    disableBrokerageAuthorization(requestParameters: ConnectionsApiDisableBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationDisabledConfirmation, any, {}>>;
-    /**
-     * Returns all brokerage accounts that belong to the specified connection for the authenticated user.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
-     * @summary List accounts for a connection
-     * @param {ConnectionsApiListBrokerageAuthorizationAccountsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ConnectionsApiGenerated
-     */
-    listBrokerageAuthorizationAccounts(requestParameters: ConnectionsApiListBrokerageAuthorizationAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any, {}>>;
-    /**
-     * 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}
-     * @memberof ConnectionsApiGenerated
-     */
-    listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any, {}>>;
-    /**
-     * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.  **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
-     * @summary Refresh holdings for a connection
-     * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ConnectionsApiGenerated
-     */
-    refreshBrokerageAuthorization(requestParameters: ConnectionsApiRefreshBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationRefreshConfirmation, any, {}>>;
-    /**
-     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
-     * @summary Delete connection
-     * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ConnectionsApiGenerated
-     */
-    removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Returns a list of rate of return percents for a given connection.
-     * @summary List connection rate of returns
-     * @param {ConnectionsApiReturnRatesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ConnectionsApiGenerated
-     */
-    returnRates(requestParameters: ConnectionsApiReturnRatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RateOfReturnResponse, any, {}>>;
-    /**
-     * Returns a list of session events associated with a user.
-     * @summary Get all session events for a user
-     * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ConnectionsApiGenerated
-     */
-    sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").SessionEvent[], any, {}>>;
-}