snaptrade-typescript-sdk 9.0.18 → 9.0.20

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.18-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.18)
+[![npm](https://img.shields.io/badge/npm-v9.0.20-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.20)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -177,6 +177,7 @@ main();
 
 
 ### `snaptrade.accountInformation.getAllUserHoldings`<a id="snaptradeaccountinformationgetalluserholdings"></a>
+![Deprecated](https://img.shields.io/badge/deprecated-yellow)
 
 Lists balances, positions and orders for the specified account. The data returned is similar to
 the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
@@ -775,7 +776,7 @@ The ID of a brokerage authorization object.
 
 ### `snaptrade.connections.listBrokerageAuthorizations`<a id="snaptradeconnectionslistbrokerageauthorizations"></a>
 
-Returns a list of Brokerage Autherization objects for the specified userId.
+Returns a list of Brokerage Authorization objects for the user
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1080,7 +1081,7 @@ const placeOptionStrategyResponse = await snaptrade.options.placeOptionStrategy(
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### order_type: [`OrderType`](./models/order-type.ts)<a id="order_type-ordertypemodelsorder-typets"></a>
+##### order_type: [`OrderTypeStrict`](./models/order-type-strict.ts)<a id="order_type-ordertypestrictmodelsorder-type-strictts"></a>
 
 Order Type
 
@@ -1119,7 +1120,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>
 
@@ -1198,7 +1199,7 @@ const getSecurityTypesResponse =
 
 ### `snaptrade.referenceData.getStockExchanges`<a id="snaptradereferencedatagetstockexchanges"></a>
 
-List exchanges
+Returns a list of all supported Exchanges.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1222,7 +1223,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>
 
@@ -1251,7 +1255,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>
 
@@ -1283,7 +1287,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>
 
@@ -1315,7 +1319,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>
 
@@ -1339,7 +1343,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>
 
@@ -1363,7 +1367,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>
 
@@ -1474,7 +1478,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>
 
@@ -1505,7 +1509,7 @@ const getOrderImpactResponse = await snaptrade.trading.getOrderImpact({
 
 Trade Action
 
-##### order_type: [`OrderType`](./models/order-type.ts)<a id="order_type-ordertypemodelsorder-typets"></a>
+##### order_type: [`OrderTypeStrict`](./models/order-type-strict.ts)<a id="order_type-ordertypestrictmodelsorder-type-strictts"></a>
 
 Order Type
 
@@ -1589,7 +1593,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>
 
@@ -1620,7 +1624,7 @@ const placeForceOrderResponse = await snaptrade.trading.placeForceOrder({
 
 Trade Action
 
-##### order_type: [`OrderType`](./models/order-type.ts)<a id="order_type-ordertypemodelsorder-typets"></a>
+##### order_type: [`OrderTypeStrict`](./models/order-type-strict.ts)<a id="order_type-ordertypestrictmodelsorder-type-strictts"></a>
 
 Order Type
 
@@ -1657,7 +1661,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>
 
@@ -1754,6 +1760,7 @@ Optional comma seperated list of types to filter activities by. This is not an e
 
 
 ### `snaptrade.transactionsAndReporting.getReportingCustomRange`<a id="snaptradetransactionsandreportinggetreportingcustomrange"></a>
+![Deprecated](https://img.shields.io/badge/deprecated-yellow)
 
 Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
 

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

@@ -19,7 +19,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      */
     detailBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of Brokerage Autherization objects for the specified userId.
+     * Returns a list of Brokerage Authorization objects for the user
      * @summary List all brokerage authorizations for the User
      * @param {string} userId
      * @param {string} userSecret
@@ -62,7 +62,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
      */
     detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorization>>;
     /**
-     * Returns a list of Brokerage Autherization objects for the specified userId.
+     * 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.
@@ -100,7 +100,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
      */
     detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorization>;
     /**
-     * Returns a list of Brokerage Autherization objects for the specified userId.
+     * 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.
@@ -235,7 +235,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
      */
     detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization, any>>;
     /**
-     * Returns a list of Brokerage Autherization objects for the specified userId.
+     * 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.

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

@@ -91,7 +91,7 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns a list of Brokerage Autherization objects for the specified userId.
+         * Returns a list of Brokerage Authorization objects for the user
          * @summary List all brokerage authorizations for the User
          * @param {string} userId
          * @param {string} userSecret
@@ -273,7 +273,7 @@ const ConnectionsApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of Brokerage Autherization objects for the specified userId.
+         * 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.
@@ -332,7 +332,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.detailBrokerageAuthorization(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of Brokerage Autherization objects for the specified userId.
+         * 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.
@@ -383,7 +383,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.ConnectionsApiFp)(this.configuration).detailBrokerageAuthorization(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns a list of Brokerage Autherization objects for the specified userId.
+     * 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.

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

@@ -16,8 +16,8 @@ import { UniversalSymbol } from '../models';
  */
 export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     *
-     * @summary Return the exchange rate of a currency pair
+     * Returns an Exchange Rate Pair object for the specified Currency Pair.
+     * @summary Get exchange rate of a currency pair
      * @param {string} currencyPair A currency pair based on currency code for example, {CAD-USD}
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -38,14 +38,14 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
      */
     getSecurityTypes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary List exchanges
+     * Returns a list of all supported Exchanges.
+     * @summary Get exchanges
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getStockExchanges: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
      * @summary Search for symbols
      * @param {SymbolQuery} [symbolQuery]
      * @param {*} [options] Override http request option.
@@ -53,38 +53,38 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
      */
     getSymbols: (symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary 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.
+     * @summary Get details of a symbol
      * @param {string} query The ticker or universal_symbol_id of the UniversalSymbol to get.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSymbolsByTicker: (query: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary List of all brokerage authorization types
+     * Returns a list of all defined Brokerage authorization Type objects.
+     * @summary Get all brokerage authorization types
      * @param {string} [brokerage] Comma separated value of brokerage slugs
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listAllBrokerageAuthorizationType: (brokerage?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary List brokerages
+     * Returns a list of all defined Brokerage objects.
+     * @summary Get brokerages
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listAllBrokerages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary List currencies
+     * Returns a list of all defined Currency objects.
+     * @summary Get currencies
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listAllCurrencies: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary List currency exchange rates
+     * Returns a list of all Exchange Rate Pairs for all supported Currencies.
+     * @summary Get currency exchange rates
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -107,8 +107,8 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
  */
 export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
     /**
-     *
-     * @summary Return the exchange rate of a currency pair
+     * Returns an Exchange Rate Pair object for the specified Currency Pair.
+     * @summary Get exchange rate of a currency pair
      * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -129,14 +129,14 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
      */
     getSecurityTypes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SecurityType>>>;
     /**
-     *
-     * @summary List exchanges
+     * Returns a list of all supported Exchanges.
+     * @summary Get exchanges
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getStockExchanges(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Exchange>>>;
     /**
-     *
+     * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
      * @summary Search for symbols
      * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -144,38 +144,38 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
      */
     getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
     /**
-     *
-     * @summary 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.
+     * @summary Get details of a symbol
      * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UniversalSymbol>>;
     /**
-     *
-     * @summary List of all brokerage authorization types
+     * Returns a list of all defined Brokerage authorization Type objects.
+     * @summary Get all brokerage authorization types
      * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>>;
     /**
-     *
-     * @summary List brokerages
+     * Returns a list of all defined Brokerage objects.
+     * @summary Get brokerages
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listAllBrokerages(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Brokerage>>>;
     /**
-     *
-     * @summary List currencies
+     * Returns a list of all defined Currency objects.
+     * @summary Get currencies
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listAllCurrencies(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Currency>>>;
     /**
-     *
-     * @summary List currency exchange rates
+     * Returns a list of all Exchange Rate Pairs for all supported Currencies.
+     * @summary Get currency exchange rates
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -195,8 +195,8 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
  */
 export declare const ReferenceDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     *
-     * @summary Return the exchange rate of a currency pair
+     * Returns an Exchange Rate Pair object for the specified Currency Pair.
+     * @summary Get exchange rate of a currency pair
      * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -217,14 +217,14 @@ export declare const ReferenceDataApiFactory: (configuration?: Configuration, ba
      */
     getSecurityTypes(options?: AxiosRequestConfig): AxiosPromise<Array<SecurityType>>;
     /**
-     *
-     * @summary List exchanges
+     * Returns a list of all supported Exchanges.
+     * @summary Get exchanges
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getStockExchanges(options?: AxiosRequestConfig): AxiosPromise<Array<Exchange>>;
     /**
-     *
+     * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
      * @summary Search for symbols
      * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -232,38 +232,38 @@ export declare const ReferenceDataApiFactory: (configuration?: Configuration, ba
      */
     getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
     /**
-     *
-     * @summary 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.
+     * @summary Get details of a symbol
      * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): AxiosPromise<UniversalSymbol>;
     /**
-     *
-     * @summary List of all brokerage authorization types
+     * Returns a list of all defined Brokerage authorization Type objects.
+     * @summary Get all brokerage authorization types
      * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>;
     /**
-     *
-     * @summary List brokerages
+     * Returns a list of all defined Brokerage objects.
+     * @summary Get brokerages
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listAllBrokerages(options?: AxiosRequestConfig): AxiosPromise<Array<Brokerage>>;
     /**
-     *
-     * @summary List currencies
+     * Returns a list of all defined Currency objects.
+     * @summary Get currencies
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listAllCurrencies(options?: AxiosRequestConfig): AxiosPromise<Array<Currency>>;
     /**
-     *
-     * @summary List currency exchange rates
+     * Returns a list of all Exchange Rate Pairs for all supported Currencies.
+     * @summary Get currency exchange rates
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -355,8 +355,8 @@ export type ReferenceDataApiSymbolSearchUserAccountRequest = {
  */
 export declare class ReferenceDataApiGenerated extends BaseAPI {
     /**
-     *
-     * @summary Return the exchange rate of a currency pair
+     * Returns an Exchange Rate Pair object for the specified Currency Pair.
+     * @summary Get exchange rate of a currency pair
      * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -380,15 +380,15 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      */
     getSecurityTypes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecurityType[], any>>;
     /**
-     *
-     * @summary List exchanges
+     * Returns a list of all supported Exchanges.
+     * @summary Get exchanges
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
     getStockExchanges(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Exchange[], any>>;
     /**
-     *
+     * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
      * @summary Search for symbols
      * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -397,8 +397,8 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      */
     getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
     /**
-     *
-     * @summary 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.
+     * @summary Get details of a symbol
      * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -406,8 +406,8 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      */
     getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol, any>>;
     /**
-     *
-     * @summary List of all brokerage authorization types
+     * Returns a list of all defined Brokerage authorization Type objects.
+     * @summary Get all brokerage authorization types
      * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -415,24 +415,24 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      */
     listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationTypeReadOnly[], any>>;
     /**
-     *
-     * @summary List brokerages
+     * Returns a list of all defined Brokerage objects.
+     * @summary Get brokerages
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
     listAllBrokerages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Brokerage[], any>>;
     /**
-     *
-     * @summary List currencies
+     * Returns a list of all defined Currency objects.
+     * @summary Get currencies
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
     listAllCurrencies(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Currency[], any>>;
     /**
-     *
-     * @summary List currency exchange rates
+     * Returns a list of all Exchange Rate Pairs for all supported Currencies.
+     * @summary Get currency exchange rates
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated