snaptrade-typescript-sdk 8.29.1 → 8.29.2

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-v8.29.1-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/8.29.1)
+[![npm](https://img.shields.io/badge/npm-v8.29.2-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/8.29.2)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -198,7 +198,7 @@ Optional. Comma seperated list of authorization IDs (only use if filtering is ne
 
 ### `snaptrade.accountInformation.getUserAccountBalance`
 
-List account balances
+A list of account balances for the specified account (one per currency that the account holds).
 
 #### 🛠️ Usage
 
@@ -274,7 +274,7 @@ The ID of the account to get detail of.
 
 ### `snaptrade.accountInformation.getUserAccountOrders`
 
-Get history of orders placed in account
+Fetch all recent orders from a user\'s account.
 
 #### 🛠️ Usage
 
@@ -355,7 +355,7 @@ The ID of the account to get positions.
 
 ### `snaptrade.accountInformation.getUserHoldings`
 
-List balances, positions and orders for the specified account.
+List balances, positions and orders for the specified account
 
 #### 🛠️ Usage
 
@@ -487,7 +487,7 @@ const checkResponse = await snaptrade.apiStatus.check();
 
 ### `snaptrade.authentication.deleteSnapTradeUser`
 
-Delete SnapTrade user
+Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
 
 #### 🛠️ Usage
 
@@ -545,7 +545,7 @@ const getUserJWTResponse = await snaptrade.authentication.getUserJWT({
 
 ### `snaptrade.authentication.listSnapTradeUsers`
 
-List SnapTrade users
+Returns a list of users you\'ve registered over the SnapTrade API.
 
 #### 🛠️ Usage
 
@@ -565,7 +565,7 @@ const listSnapTradeUsersResponse =
 
 ### `snaptrade.authentication.loginSnapTradeUser`
 
-Login user &amp; generate connection link
+Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
 
 #### 🛠️ Usage
 
@@ -590,14 +590,24 @@ const loginSnapTradeUserResponse =
 
 ##### broker: `string`
 
+Slug of the brokerage to connect the user to
+
 ##### immediateRedirect: `boolean`
 
+When set to True, user will be redirected back to the partner\\\'s site instead of the connection portal
+
 ##### customRedirect: `string`
 
+URL to redirect the user to after the user connects their brokerage account
+
 ##### reconnect: `string`
 
+The UUID of the brokerage connection to be reconnected
+
 ##### connectionType: `string`
 
+Sets whether the connection should be read or trade
+
 #### 🌐 Endpoint
 
 `/snapTrade/login` `POST`
@@ -617,8 +627,6 @@ Create SnapTrade user
 const registerSnapTradeUserResponse =
   await snaptrade.authentication.registerSnapTradeUser({
     userId: "snaptrade-user-123",
-    rsaPublicKey:
-      "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw==",
   });
 ```
 
@@ -628,10 +636,6 @@ const registerSnapTradeUserResponse =
 
 SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\\\'s unique to a user
 
-##### rsaPublicKey: `string`
-
-Open SSH RSA public key
-
 #### 🔄 Return
 
 [UserIDandSecret](./models/user-idand-secret.ts)
@@ -1102,7 +1106,7 @@ const getPartnerInfoResponse = await snaptrade.referenceData.getPartnerInfo();
 
 ### `snaptrade.referenceData.getSecurityTypes`
 
-List of all security types.
+List security types available on SnapTrade.
 
 #### 🛠️ Usage
 
@@ -1643,7 +1647,7 @@ The ID of trade object obtained from trade/impact endpoint
 
 ### `snaptrade.transactionsAndReporting.getActivities`
 
-Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
 
 #### 🛠️ Usage
 

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

@@ -24,7 +24,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
      */
     getAllUserHoldings: (userId: string, userSecret: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * A list of account balances for the specified account (one per currency that the account holds).
      * @summary List account balances
      * @param {string} userId
      * @param {string} userSecret
@@ -44,7 +44,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
      */
     getUserAccountDetails: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Fetch all recent orders from a user\'s account.
      * @summary Get history of orders placed in account
      * @param {string} userId
      * @param {string} userSecret
@@ -66,7 +66,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
     getUserAccountPositions: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary List balances, positions and orders for the specified account.
+     * @summary List balances, positions and orders for the specified account
      * @param {string} accountId The ID of the account to fetch holdings for.
      * @param {string} userId
      * @param {string} userSecret
@@ -109,7 +109,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
      */
     getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
     /**
-     *
+     * A list of account balances for the specified account (one per currency that the account holds).
      * @summary List account balances
      * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -125,7 +125,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
      */
     getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Account>>;
     /**
-     *
+     * Fetch all recent orders from a user\'s account.
      * @summary Get history of orders placed in account
      * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -142,7 +142,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
     getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Position>>>;
     /**
      *
-     * @summary List balances, positions and orders for the specified account.
+     * @summary List balances, positions and orders for the specified account
      * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -180,7 +180,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
      */
     getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
     /**
-     *
+     * A list of account balances for the specified account (one per currency that the account holds).
      * @summary List account balances
      * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -196,7 +196,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
      */
     getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<Account>;
     /**
-     *
+     * Fetch all recent orders from a user\'s account.
      * @summary Get history of orders placed in account
      * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -213,7 +213,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
     getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Position>>;
     /**
      *
-     * @summary List balances, positions and orders for the specified account.
+     * @summary List balances, positions and orders for the specified account
      * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -454,7 +454,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
      */
     getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldings[], any>>;
     /**
-     *
+     * A list of account balances for the specified account (one per currency that the account holds).
      * @summary List account balances
      * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -472,7 +472,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
      */
     getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account, any>>;
     /**
-     *
+     * Fetch all recent orders from a user\'s account.
      * @summary Get history of orders placed in account
      * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -491,7 +491,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
     getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Position[], any>>;
     /**
      *
-     * @summary List balances, positions and orders for the specified account.
+     * @summary List balances, positions and orders for the specified account
      * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

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

@@ -90,7 +90,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
+         * A list of account balances for the specified account (one per currency that the account holds).
          * @summary List account balances
          * @param {string} userId
          * @param {string} userSecret
@@ -196,7 +196,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
+         * Fetch all recent orders from a user\'s account.
          * @summary Get history of orders placed in account
          * @param {string} userId
          * @param {string} userSecret
@@ -307,7 +307,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
         }),
         /**
          *
-         * @summary List balances, positions and orders for the specified account.
+         * @summary List balances, positions and orders for the specified account
          * @param {string} accountId The ID of the account to fetch holdings for.
          * @param {string} userId
          * @param {string} userSecret
@@ -485,7 +485,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * A list of account balances for the specified account (one per currency that the account holds).
          * @summary List account balances
          * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -511,7 +511,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Fetch all recent orders from a user\'s account.
          * @summary Get history of orders placed in account
          * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -538,7 +538,7 @@ const AccountInformationApiFp = function (configuration) {
         },
         /**
          *
-         * @summary List balances, positions and orders for the specified account.
+         * @summary List balances, positions and orders for the specified account
          * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -597,7 +597,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getAllUserHoldings(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * A list of account balances for the specified account (one per currency that the account holds).
          * @summary List account balances
          * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -617,7 +617,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserAccountDetails(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * Fetch all recent orders from a user\'s account.
          * @summary Get history of orders placed in account
          * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -638,7 +638,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
         },
         /**
          *
-         * @summary List balances, positions and orders for the specified account.
+         * @summary List balances, positions and orders for the specified account
          * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -689,7 +689,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getAllUserHoldings(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * A list of account balances for the specified account (one per currency that the account holds).
      * @summary List account balances
      * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -711,7 +711,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountDetails(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * Fetch all recent orders from a user\'s account.
      * @summary Get history of orders placed in account
      * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -734,7 +734,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
     }
     /**
      *
-     * @summary List balances, positions and orders for the specified account.
+     * @summary List balances, positions and orders for the specified account
      * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

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

@@ -13,7 +13,7 @@ import { UserIDandSecret } from '../models';
  */
 export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     *
+     * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
      * @summary Delete SnapTrade user
      * @param {string} userId
      * @param {*} [options] Override http request option.
@@ -30,14 +30,14 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
      */
     getUserJWT: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Returns a list of users you\'ve registered over the SnapTrade API.
      * @summary List SnapTrade users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listSnapTradeUsers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
      * @summary Login user & generate connection link
      * @param {string} userId
      * @param {string} userSecret
@@ -61,7 +61,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
  */
 export declare const AuthenticationApiFp: (configuration?: Configuration) => {
     /**
-     *
+     * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
      * @summary Delete SnapTrade user
      * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -77,14 +77,14 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
      */
     getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EncryptedResponse>>;
     /**
-     *
+     * Returns a list of users you\'ve registered over the SnapTrade API.
      * @summary List SnapTrade users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listSnapTradeUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
     /**
-     *
+     * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
      * @summary Login user & generate connection link
      * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -106,7 +106,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
  */
 export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     *
+     * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
      * @summary Delete SnapTrade user
      * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -122,14 +122,14 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
      */
     getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): AxiosPromise<EncryptedResponse>;
     /**
-     *
+     * Returns a list of users you\'ve registered over the SnapTrade API.
      * @summary List SnapTrade users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listSnapTradeUsers(options?: AxiosRequestConfig): AxiosPromise<Array<string>>;
     /**
-     *
+     * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
      * @summary Login user & generate connection link
      * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -210,7 +210,7 @@ export type AuthenticationApiRegisterSnapTradeUserRequest = {} & SnapTradeRegist
  */
 export declare class AuthenticationApiGenerated extends BaseAPI {
     /**
-     *
+     * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
      * @summary Delete SnapTrade user
      * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -228,7 +228,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
      */
     getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EncryptedResponse, any>>;
     /**
-     *
+     * Returns a list of users you\'ve registered over the SnapTrade API.
      * @summary List SnapTrade users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -236,7 +236,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
      */
     listSnapTradeUsers(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
     /**
-     *
+     * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
      * @summary Login user & generate connection link
      * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
 const AuthenticationApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         *
+         * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
          * @summary Delete SnapTrade user
          * @param {string} userId
          * @param {*} [options] Override http request option.
@@ -128,7 +128,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
+         * Returns a list of users you\'ve registered over the SnapTrade API.
          * @summary List SnapTrade users
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -165,7 +165,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
+         * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
          * @summary Login user & generate connection link
          * @param {string} userId
          * @param {string} userSecret
@@ -271,7 +271,7 @@ const AuthenticationApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.AuthenticationApiAxiosParamCreator)(configuration);
     return {
         /**
-         *
+         * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
          * @summary Delete SnapTrade user
          * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -297,7 +297,7 @@ const AuthenticationApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Returns a list of users you\'ve registered over the SnapTrade API.
          * @summary List SnapTrade users
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -309,7 +309,7 @@ const AuthenticationApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
          * @summary Login user & generate connection link
          * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -345,7 +345,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.AuthenticationApiFp)(configuration);
     return {
         /**
-         *
+         * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
          * @summary Delete SnapTrade user
          * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -365,7 +365,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserJWT(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * Returns a list of users you\'ve registered over the SnapTrade API.
          * @summary List SnapTrade users
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -374,7 +374,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listSnapTradeUsers(options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
          * @summary Login user & generate connection link
          * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -404,7 +404,7 @@ exports.AuthenticationApiFactory = AuthenticationApiFactory;
  */
 class AuthenticationApiGenerated extends base_1.BaseAPI {
     /**
-     *
+     * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
      * @summary Delete SnapTrade user
      * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -426,7 +426,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AuthenticationApiFp)(this.configuration).getUserJWT(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * Returns a list of users you\'ve registered over the SnapTrade API.
      * @summary List SnapTrade users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -436,7 +436,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AuthenticationApiFp)(this.configuration).listSnapTradeUsers(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
      * @summary Login user & generate connection link
      * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/reference-data-api-generated.d.ts

@@ -31,8 +31,8 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
      */
     getPartnerInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary List of all security types.
+     * List security types available on SnapTrade.
+     * @summary List of all security types
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -123,8 +123,8 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
      */
     getPartnerInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerData>>;
     /**
-     *
-     * @summary List of all security types.
+     * List security types available on SnapTrade.
+     * @summary List of all security types
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -211,8 +211,8 @@ export declare const ReferenceDataApiFactory: (configuration?: Configuration, ba
      */
     getPartnerInfo(options?: AxiosRequestConfig): AxiosPromise<PartnerData>;
     /**
-     *
-     * @summary List of all security types.
+     * List security types available on SnapTrade.
+     * @summary List of all security types
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -379,8 +379,8 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      */
     getPartnerInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerData, any>>;
     /**
-     *
-     * @summary List of all security types.
+     * List security types available on SnapTrade.
+     * @summary List of all security types
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated

package/dist/api/reference-data-api-generated.js

@@ -114,8 +114,8 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
-         * @summary List of all security types.
+         * List security types available on SnapTrade.
+         * @summary List of all security types
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -518,8 +518,8 @@ const ReferenceDataApiFp = function (configuration) {
             });
         },
         /**
-         *
-         * @summary List of all security types.
+         * List security types available on SnapTrade.
+         * @summary List of all security types
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -659,8 +659,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getPartnerInfo(options).then((request) => request(axios, basePath));
         },
         /**
-         *
-         * @summary List of all security types.
+         * List security types available on SnapTrade.
+         * @summary List of all security types
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -775,8 +775,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
         return (0, exports.ReferenceDataApiFp)(this.configuration).getPartnerInfo(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
-     * @summary List of all security types.
+     * List security types available on SnapTrade.
+     * @summary List of all security types
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated

package/dist/api/transactions-and-reporting-api-generated.d.ts

@@ -9,7 +9,7 @@ import { UniversalActivity } from '../models';
  */
 export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
      * @summary Get transaction history for a user
      * @param {string} userId
      * @param {string} userSecret
@@ -43,7 +43,7 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
  */
 export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
     /**
-     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
      * @summary Get transaction history for a user
      * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -65,7 +65,7 @@ export declare const TransactionsAndReportingApiFp: (configuration?: Configurati
  */
 export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
      * @summary Get transaction history for a user
      * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -187,7 +187,7 @@ export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
  */
 export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
     /**
-     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
      * @summary Get transaction history for a user
      * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.