snaptrade-typescript-sdk 9.0.17 → 9.0.19

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.17-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.17)
+[![npm](https://img.shields.io/badge/npm-v9.0.19-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.19)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -344,7 +344,7 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
 
 ### `snaptrade.accountInformation.getUserAccountPositions`<a id="snaptradeaccountinformationgetuseraccountpositions"></a>
 
-Returns a list of positions in the the specified account.
+Returns a list of positions in the specified account.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -737,7 +737,7 @@ SnapTrade User Secret randomly generated by SnapTrade. This should be considered
 
 ### `snaptrade.connections.detailBrokerageAuthorization`<a id="snaptradeconnectionsdetailbrokerageauthorization"></a>
 
-Get brokerage authorization details
+Returns a single brokerage authorization object for the specified ID.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -775,7 +775,7 @@ The ID of a brokerage authorization object.
 
 ### `snaptrade.connections.listBrokerageAuthorizations`<a id="snaptradeconnectionslistbrokerageauthorizations"></a>
 
-List all brokerage authorizations for the user
+Returns a list of Brokerage Authorization objects for the user
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -808,7 +808,7 @@ const listBrokerageAuthorizationsResponse =
 
 ### `snaptrade.connections.removeBrokerageAuthorization`<a id="snaptradeconnectionsremovebrokerageauthorization"></a>
 
-Delete brokerage authorization
+Deletes a specified brokerage authorization given by the ID.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -842,7 +842,7 @@ The ID of the Authorization to delete.
 
 ### `snaptrade.connections.sessionEvents`<a id="snaptradeconnectionssessionevents"></a>
 
-List all session events for the partner
+Returns a list of session events associated with a user.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -883,7 +883,8 @@ Optional comma seperated list of session IDs used to filter the request on speci
 
 ### `snaptrade.options.getOptionStrategy`<a id="snaptradeoptionsgetoptionstrategy"></a>
 
-Creates an option strategy object that will be used to place an option strategy order
+Creates an option strategy object that will be used to place an option strategy order.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -935,7 +936,7 @@ The ID of the account to create the option strategy object in.
 
 ### `snaptrade.options.getOptionsChain`<a id="snaptradeoptionsgetoptionschain"></a>
 
-Get the options chain
+Returns the option chain for the specified symbol in the specified account.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -977,7 +978,8 @@ Universal symbol ID if symbol
 
 ### `snaptrade.options.getOptionsStrategyQuote`<a id="snaptradeoptionsgetoptionsstrategyquote"></a>
 
-Get latest market data of option strategy
+Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1020,7 +1022,8 @@ Option strategy id obtained from response when creating option strategy object
 
 ### `snaptrade.options.listOptionHoldings`<a id="snaptradeoptionslistoptionholdings"></a>
 
-Get the options holdings in the account
+Returns a list of Options Positions.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1057,7 +1060,7 @@ The ID of the account to fetch options holdings for.
 
 ### `snaptrade.options.placeOptionStrategy`<a id="snaptradeoptionsplaceoptionstrategy"></a>
 
-Place an option strategy order on the brokerage
+Places the option strategy order and returns the order record received from the brokerage.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1116,7 +1119,7 @@ Trade Price if limit or stop limit order
 
 ### `snaptrade.referenceData.getCurrencyExchangeRatePair`<a id="snaptradereferencedatagetcurrencyexchangeratepair"></a>
 
-Return the exchange rate of a currency pair
+Returns an Exchange Rate Pair object for the specified Currency Pair.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1195,7 +1198,7 @@ const getSecurityTypesResponse =
 
 ### `snaptrade.referenceData.getStockExchanges`<a id="snaptradereferencedatagetstockexchanges"></a>
 
-List exchanges
+Returns a list of all supported Exchanges.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1219,7 +1222,10 @@ const getStockExchangesResponse =
 
 ### `snaptrade.referenceData.getSymbols`<a id="snaptradereferencedatagetsymbols"></a>
 
-Search for symbols
+Returns a list of Universal Symbol objects that match a defined string.
+
+Matches on ticker or name.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1248,7 +1254,7 @@ const getSymbolsResponse = await snaptrade.referenceData.getSymbols({
 
 ### `snaptrade.referenceData.getSymbolsByTicker`<a id="snaptradereferencedatagetsymbolsbyticker"></a>
 
-Get details of a symbol by the ticker or the universal_symbol_id
+Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1280,7 +1286,7 @@ The ticker or universal_symbol_id of the UniversalSymbol to get.
 
 ### `snaptrade.referenceData.listAllBrokerageAuthorizationType`<a id="snaptradereferencedatalistallbrokerageauthorizationtype"></a>
 
-List of all brokerage authorization types
+Returns a list of all defined Brokerage authorization Type objects.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1312,7 +1318,7 @@ Comma separated value of brokerage slugs
 
 ### `snaptrade.referenceData.listAllBrokerages`<a id="snaptradereferencedatalistallbrokerages"></a>
 
-List brokerages
+Returns a list of all defined Brokerage objects.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1336,7 +1342,7 @@ const listAllBrokeragesResponse =
 
 ### `snaptrade.referenceData.listAllCurrencies`<a id="snaptradereferencedatalistallcurrencies"></a>
 
-List currencies
+Returns a list of all defined Currency objects.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1360,7 +1366,7 @@ const listAllCurrenciesResponse =
 
 ### `snaptrade.referenceData.listAllCurrenciesRates`<a id="snaptradereferencedatalistallcurrenciesrates"></a>
 
-List currency exchange rates
+Returns a list of all Exchange Rate Pairs for all supported Currencies.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1471,7 +1477,7 @@ The ID of the account to cancel the order in.
 
 ### `snaptrade.trading.getOrderImpact`<a id="snaptradetradinggetorderimpact"></a>
 
-Check impact of trades on account.
+Return the trade object and it's impact on the account for the specified order.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1586,7 +1592,7 @@ Should be set to True if providing tickers.
 
 ### `snaptrade.trading.placeForceOrder`<a id="snaptradetradingplaceforceorder"></a>
 
-Place a trade with NO validation.
+Places a specified trade in the specified account.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1654,7 +1660,9 @@ Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Goo
 
 ### `snaptrade.trading.placeOrder`<a id="snaptradetradingplaceorder"></a>
 
-Place order
+Places the specified trade object. This places the order in the account and
+returns the status of the order from the brokerage.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

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

@@ -56,7 +56,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
      */
     getUserAccountOrders: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', days?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of positions in the the specified account.
+     * Returns a list of positions in the specified account.
      * @summary List account positions
      * @param {string} userId
      * @param {string} userSecret
@@ -134,7 +134,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
      */
     getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
     /**
-     * Returns a list of positions in the the specified account.
+     * Returns a list of positions in the specified account.
      * @summary List account positions
      * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -205,7 +205,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
      */
     getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
     /**
-     * Returns a list of positions in the the specified account.
+     * Returns a list of positions in the specified account.
      * @summary List account positions
      * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -488,7 +488,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
      */
     getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord[], any>>;
     /**
-     * Returns a list of positions in the the specified account.
+     * Returns a list of positions in the specified account.
      * @summary List account positions
      * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -265,7 +265,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns a list of positions in the the specified account.
+         * Returns a list of positions in the specified account.
          * @summary List account positions
          * @param {string} userId
          * @param {string} userSecret
@@ -544,7 +544,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of positions in the the specified account.
+         * Returns a list of positions in the specified account.
          * @summary List account positions
          * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -647,7 +647,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserAccountOrders(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of positions in the the specified account.
+         * Returns a list of positions in the specified account.
          * @summary List account positions
          * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -742,7 +742,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountOrders(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns a list of positions in the the specified account.
+     * Returns a list of positions in the specified account.
      * @summary List account positions
      * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -9,7 +9,7 @@ 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.
      * @param {string} userId
@@ -19,8 +19,8 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      */
     detailBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary List all brokerage authorizations for the user
+     * Returns a list of Brokerage Authorization objects for the user
+     * @summary List all brokerage authorizations for the User
      * @param {string} userId
      * @param {string} userSecret
      * @param {*} [options] Override http request option.
@@ -28,7 +28,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      */
     listBrokerageAuthorizations: (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.
      * @param {string} userId
@@ -38,8 +38,8 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      */
     removeBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary List all session events for the partner
+     * 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
@@ -54,7 +54,7 @@ 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
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -62,15 +62,15 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
      */
     detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorization>>;
     /**
-     *
-     * @summary List all brokerage authorizations for the user
+     * Returns a list of Brokerage Authorization objects for the user
+     * @summary List all brokerage authorizations for the User
      * @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>>>;
     /**
-     *
+     * Deletes a specified brokerage authorization given by the ID.
      * @summary Delete brokerage authorization
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -78,8 +78,8 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
      */
     removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     *
-     * @summary List all session events for the partner
+     * 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}
@@ -92,7 +92,7 @@ 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
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -100,15 +100,15 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
      */
     detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorization>;
     /**
-     *
-     * @summary List all brokerage authorizations for the user
+     * Returns a list of Brokerage Authorization objects for the user
+     * @summary List all brokerage authorizations for the User
      * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
     /**
-     *
+     * Deletes a specified brokerage authorization given by the ID.
      * @summary Delete brokerage authorization
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -116,8 +116,8 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
      */
     removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
-     *
-     * @summary List all session events for the partner
+     * 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}
@@ -226,7 +226,7 @@ export type ConnectionsApiSessionEventsRequest = {
  */
 export declare class ConnectionsApiGenerated extends BaseAPI {
     /**
-     *
+     * Returns a single brokerage authorization object for the specified ID.
      * @summary Get brokerage authorization details
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -235,8 +235,8 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
      */
     detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization, any>>;
     /**
-     *
-     * @summary List all brokerage authorizations for the user
+     * Returns a list of Brokerage Authorization objects for the user
+     * @summary List all brokerage authorizations for the User
      * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -244,7 +244,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
      */
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any>>;
     /**
-     *
+     * Deletes a specified brokerage authorization given by the ID.
      * @summary Delete brokerage authorization
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -253,8 +253,8 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
      */
     removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     *
-     * @summary List all session events for the partner
+     * 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}

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

@@ -36,7 +36,7 @@ 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.
          * @param {string} userId
@@ -91,8 +91,8 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
-         * @summary List all brokerage authorizations for the user
+         * Returns a list of Brokerage Authorization objects for the user
+         * @summary List all brokerage authorizations for the User
          * @param {string} userId
          * @param {string} userSecret
          * @param {*} [options] Override http request option.
@@ -142,7 +142,7 @@ 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.
          * @param {string} userId
@@ -197,8 +197,8 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
-         * @summary List all session events for the partner
+         * 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
@@ -260,7 +260,7 @@ 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
          * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -273,8 +273,8 @@ const ConnectionsApiFp = function (configuration) {
             });
         },
         /**
-         *
-         * @summary List all brokerage authorizations for the user
+         * Returns a list of Brokerage Authorization objects for the user
+         * @summary List all brokerage authorizations for the User
          * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -286,7 +286,7 @@ const ConnectionsApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Deletes a specified brokerage authorization given by the ID.
          * @summary Delete brokerage authorization
          * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -299,8 +299,8 @@ const ConnectionsApiFp = function (configuration) {
             });
         },
         /**
-         *
-         * @summary List all session events for the partner
+         * 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}
@@ -322,7 +322,7 @@ 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
          * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -332,8 +332,8 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.detailBrokerageAuthorization(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
-         * @summary List all brokerage authorizations for the user
+         * Returns a list of Brokerage Authorization objects for the user
+         * @summary List all brokerage authorizations for the User
          * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -342,7 +342,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listBrokerageAuthorizations(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * Deletes a specified brokerage authorization given by the ID.
          * @summary Delete brokerage authorization
          * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -352,8 +352,8 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.removeBrokerageAuthorization(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
-         * @summary List all session events for the partner
+         * 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}
@@ -372,7 +372,7 @@ exports.ConnectionsApiFactory = ConnectionsApiFactory;
  */
 class ConnectionsApiGenerated extends base_1.BaseAPI {
     /**
-     *
+     * Returns a single brokerage authorization object for the specified ID.
      * @summary Get brokerage authorization details
      * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -383,8 +383,8 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.ConnectionsApiFp)(this.configuration).detailBrokerageAuthorization(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
-     * @summary List all brokerage authorizations for the user
+     * Returns a list of Brokerage Authorization objects for the user
+     * @summary List all brokerage authorizations for the User
      * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -394,7 +394,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.ConnectionsApiFp)(this.configuration).listBrokerageAuthorizations(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * Deletes a specified brokerage authorization given by the ID.
      * @summary Delete brokerage authorization
      * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -405,8 +405,8 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.ConnectionsApiFp)(this.configuration).removeBrokerageAuthorization(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
-     * @summary List all session events for the partner
+     * 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}