snaptrade-typescript-sdk 12.2.11 → 12.2.13

package/dist/index.cjs

@@ -418,7 +418,7 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
 			};
 		},
 		/**
-		* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the Add-on section of the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) 
+		* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) 
 		* @summary List historical account total value
 		* @param {string} accountId 
 		* @param {string} [userId] 
@@ -940,7 +940,7 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
 			};
 		},
 		/**
-		* Returns a list of rate of return percents for a given account. 
+		* DEPRECATED. Returns a list of rate of return percents for a given account. 
 		* @summary List account rate of returns
 		* @param {string} accountId 
 		* @param {string} [timeframes] Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
@@ -1265,7 +1265,7 @@ const AccountInformationApiFp = function(configuration) {
 			});
 		},
 		/**
-		* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the Add-on section of the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) 
+		* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) 
 		* @summary List historical account total value
 		* @param {AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>} requestParameters Request parameters.
 		* @param {*} [options] Override http request option.
@@ -1427,7 +1427,7 @@ const AccountInformationApiFp = function(configuration) {
 			});
 		},
 		/**
-		* Returns a list of rate of return percents for a given account. 
+		* DEPRECATED. Returns a list of rate of return percents for a given account. 
 		* @summary List account rate of returns
 		* @param {AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>} requestParameters Request parameters.
 		* @param {*} [options] Override http request option.
@@ -1539,7 +1539,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios$8)
 			return localVarFp.getAccountActivities(...args).then((request) => request(axios$8, basePath));
 		},
 		/**
-		* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the Add-on section of the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) 
+		* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) 
 		* @summary List historical account total value
 		* @param {AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>} requestParameters Request parameters.
 		* @param {*} [options] Override http request option.
@@ -1609,7 +1609,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios$8)
 			return localVarFp.getUserAccountRecentOrders(...args).then((request) => request(axios$8, basePath));
 		},
 		/**
-		* Returns a list of rate of return percents for a given account. 
+		* DEPRECATED. Returns a list of rate of return percents for a given account. 
 		* @summary List account rate of returns
 		* @param {AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>} requestParameters Request parameters.
 		* @param {*} [options] Override http request option.
@@ -1670,7 +1670,7 @@ var AccountInformationApiGenerated = class extends BaseAPI {
 		return AccountInformationApiFp(this.configuration).getAccountActivities(...args).then((request) => request(this.axios, this.basePath));
 	}
 	/**
-	* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the Add-on section of the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) 
+	* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) 
 	* @summary List historical account total value
 	* @param {AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>} requestParameters Request parameters.
 	* @param {*} [options] Override http request option.
@@ -1747,7 +1747,7 @@ var AccountInformationApiGenerated = class extends BaseAPI {
 		return AccountInformationApiFp(this.configuration).getUserAccountRecentOrders(...args).then((request) => request(this.axios, this.basePath));
 	}
 	/**
-	* Returns a list of rate of return percents for a given account. 
+	* DEPRECATED. Returns a list of rate of return percents for a given account. 
 	* @summary List account rate of returns
 	* @param {AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>} requestParameters Request parameters.
 	* @param {*} [options] Override http request option.
@@ -2969,7 +2969,7 @@ const ConnectionsApiAxiosParamCreator = function(configuration) {
 			};
 		},
 		/**
-		* Returns a list of rate of return percents for a given connection. 
+		* DEPRECATED. Returns a list of rate of return percents for a given connection. 
 		* @summary List connection rate of returns
 		* @param {string} authorizationId 
 		* @param {string} [timeframes] Optional comma separated list of rate-of-return timeframes to return. Supported values are &#x60;ALL&#x60;, &#x60;1Y&#x60;, &#x60;YTD&#x60;, &#x60;1M&#x60;, &#x60;1W&#x60;, and &#x60;1D&#x60;. If omitted, SnapTrade returns all six supported timeframes.
@@ -3287,7 +3287,7 @@ const ConnectionsApiFp = function(configuration) {
 			});
 		},
 		/**
-		* Returns a list of rate of return percents for a given connection. 
+		* DEPRECATED. Returns a list of rate of return percents for a given connection. 
 		* @summary List connection rate of returns
 		* @param {ConnectionsApiReturnRatesRequest<TAuth>} requestParameters Request parameters.
 		* @param {*} [options] Override http request option.
@@ -3412,7 +3412,7 @@ const ConnectionsApiFactory = function(configuration, basePath, axios$5) {
 			return localVarFp.refreshBrokerageAuthorization(...args).then((request) => request(axios$5, basePath));
 		},
 		/**
-		* Returns a list of rate of return percents for a given connection. 
+		* DEPRECATED. Returns a list of rate of return percents for a given connection. 
 		* @summary List connection rate of returns
 		* @param {ConnectionsApiReturnRatesRequest<TAuth>} requestParameters Request parameters.
 		* @param {*} [options] Override http request option.
@@ -3518,7 +3518,7 @@ var ConnectionsApiGenerated = class extends BaseAPI {
 		return ConnectionsApiFp(this.configuration).refreshBrokerageAuthorization(...args).then((request) => request(this.axios, this.basePath));
 	}
 	/**
-	* Returns a list of rate of return percents for a given connection. 
+	* DEPRECATED. Returns a list of rate of return percents for a given connection. 
 	* @summary List connection rate of returns
 	* @param {ConnectionsApiReturnRatesRequest<TAuth>} requestParameters Request parameters.
 	* @param {*} [options] Override http request option.
@@ -4760,6 +4760,49 @@ const ReferenceDataApiAxiosParamCreator = function(configuration) {
 			};
 		},
 		/**
+		* Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.  A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don\'t recognize. 
+		* @summary List institutions
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		listInstitutions: async (options = {}) => {
+			const localVarPath = `/institutions`;
+			const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+			let baseOptions;
+			if (configuration) baseOptions = configuration.baseOptions;
+			const localVarRequestOptions = {
+				method: "GET",
+				...baseOptions,
+				...options
+			};
+			const localVarHeaderParameter = configuration && !isBrowser() ? { "User-Agent": configuration.userAgent } : {};
+			const localVarQueryParameter = {};
+			const localVarOperationAuth = {
+				authModes: ["public"],
+				selectedAuthMode: configuration?.authMode
+			};
+			let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+			localVarRequestOptions.headers = {
+				...localVarHeaderParameter,
+				...headersFromBaseOptions,
+				...options.headers
+			};
+			requestBeforeHook({
+				queryParameters: localVarQueryParameter,
+				requestConfig: localVarRequestOptions,
+				path: localVarPath,
+				configuration,
+				pathTemplate: "/institutions",
+				httpMethod: "GET",
+				operationAuth: localVarOperationAuth
+			});
+			setSearchParams(localVarUrlObj, localVarQueryParameter);
+			return {
+				url: toPathString(localVarUrlObj),
+				options: localVarRequestOptions
+			};
+		},
+		/**
 		* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under. 
 		* @summary Search account symbols
 		* @param {string} accountId 
@@ -5005,6 +5048,15 @@ const ReferenceDataApiFp = function(configuration) {
 			});
 		},
 		/**
+		* Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.  A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don\'t recognize. 
+		* @summary List institutions
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		async listInstitutions(options) {
+			return createRequestFunction(await localVarAxiosParamCreator.listInstitutions(options), axios.default, BASE_PATH, configuration, { authModes: ["public"] });
+		},
+		/**
 		* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under. 
 		* @summary Search account symbols
 		* @param {ReferenceDataApiSymbolSearchUserAccountRequest<TAuth>} requestParameters Request parameters.
@@ -5105,6 +5157,15 @@ const ReferenceDataApiFactory = function(configuration, basePath, axios$3) {
 			return localVarFp.listAllBrokerages(...args).then((request) => request(axios$3, basePath));
 		},
 		/**
+		* Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.  A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don\'t recognize. 
+		* @summary List institutions
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		listInstitutions(options) {
+			return localVarFp.listInstitutions(options).then((request) => request(axios$3, basePath));
+		},
+		/**
 		* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under. 
 		* @summary Search account symbols
 		* @param {ReferenceDataApiSymbolSearchUserAccountRequest<TAuth>} requestParameters Request parameters.
@@ -5198,6 +5259,16 @@ var ReferenceDataApiGenerated = class extends BaseAPI {
 		return ReferenceDataApiFp(this.configuration).listAllBrokerages(...args).then((request) => request(this.axios, this.basePath));
 	}
 	/**
+	* Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.  A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don\'t recognize. 
+	* @summary List institutions
+	* @param {*} [options] Override http request option.
+	* @throws {RequiredError}
+	* @memberof ReferenceDataApiGenerated
+	*/
+	listInstitutions(options) {
+		return ReferenceDataApiFp(this.configuration).listInstitutions(options).then((request) => request(this.axios, this.basePath));
+	}
+	/**
 	* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under. 
 	* @summary Search account symbols
 	* @param {ReferenceDataApiSymbolSearchUserAccountRequest<TAuth>} requestParameters Request parameters.
@@ -7080,7 +7151,7 @@ var Configuration = class {
 		}
 		this.basePath = param.basePath;
 		this.baseOptions = param.baseOptions ?? {};
-		this.userAgent = param.userAgent === void 0 ? "Konfig/12.2.11/typescript" : param.userAgent;
+		this.userAgent = param.userAgent === void 0 ? "Konfig/12.2.13/typescript" : param.userAgent;
 		this.formDataCtor = param.formDataCtor;
 	}
 	/**