snaptrade-typescript-sdk 12.1.3 → 12.1.5

package/dist/index.cjs

@@ -981,6 +981,77 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
 			};
 		},
 		/**
+		* Returns where the user\'s total assets sit within the distribution of a cohort of comparable users, as a coarse bucket plus an integer percentile.  The cohort is scoped to your own book: a user is only ever compared against your other users, never across SnapTrade customers. (Users on personal-use keys are the exception — they are compared against all other personal-use users, since a personal key has a single user and cannot form a distribution of its own.) The distribution is recomputed monthly, and `as_of` reports which month\'s distribution the placement came from.  `data` is `null` — a 200, not an error — when SnapTrade declines to place the user. That happens when the cohort is too small to publish a distribution, or when the user\'s own holdings are incomplete or stale (for example they hold a disabled connection). A placement computed from a partial view of a user\'s assets would understate them, so none is returned. 
+		* @summary Get the user\'s AUM percentile
+		* @param {string} [userId] 
+		* @param {string} [userSecret] 
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		getUserAumPercentile: async (userId, userSecret, options = {}) => {
+			const localVarPath = `/aumPercentile`;
+			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 = {};
+			if (configuration?.authMode === "commercialApiKey") {
+				await setApiKeyToObject({
+					object: localVarQueryParameter,
+					key: "clientId",
+					keyParamName: "clientId",
+					configuration
+				});
+				if (userId !== void 0) localVarQueryParameter["userId"] = userId;
+				if (userSecret !== void 0) localVarQueryParameter["userSecret"] = userSecret;
+			}
+			if (configuration?.authMode === "personalApiKey") await setApiKeyToObject({
+				object: localVarQueryParameter,
+				key: "clientId",
+				keyParamName: "clientId",
+				configuration
+			});
+			const localVarOperationAuth = {
+				authModes: ["commercialApiKey", "personalApiKey"],
+				requestSigningByAuthMode: {
+					"commercialApiKey": {
+						secretParameter: "consumerKey",
+						signedSecuritySchemes: ["PartnerSignature", "PartnerTimestamp"]
+					},
+					"personalApiKey": {
+						secretParameter: "consumerKey",
+						signedSecuritySchemes: ["PersonalSignature", "PersonalTimestamp"]
+					}
+				},
+				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: "/aumPercentile",
+				httpMethod: "GET",
+				operationAuth: localVarOperationAuth
+			});
+			setSearchParams(localVarUrlObj, localVarQueryParameter);
+			return {
+				url: toPathString(localVarUrlObj),
+				options: localVarRequestOptions
+			};
+		},
+		/**
 		* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).  This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.  Returns a list of balances, positions, and recent orders for the specified account.  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:   - If you do, this endpoint returns real-time data.   - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
 		* @summary List account holdings
 		* @param {string} accountId 
@@ -1407,6 +1478,28 @@ const AccountInformationApiFp = function(configuration) {
 			});
 		},
 		/**
+		* Returns where the user\'s total assets sit within the distribution of a cohort of comparable users, as a coarse bucket plus an integer percentile.  The cohort is scoped to your own book: a user is only ever compared against your other users, never across SnapTrade customers. (Users on personal-use keys are the exception — they are compared against all other personal-use users, since a personal key has a single user and cannot form a distribution of its own.) The distribution is recomputed monthly, and `as_of` reports which month\'s distribution the placement came from.  `data` is `null` — a 200, not an error — when SnapTrade declines to place the user. That happens when the cohort is too small to publish a distribution, or when the user\'s own holdings are incomplete or stale (for example they hold a disabled connection). A placement computed from a partial view of a user\'s assets would understate them, so none is returned. 
+		* @summary Get the user\'s AUM percentile
+		* @param {AccountInformationApiGetUserAumPercentileRequest<TAuth>} requestParameters Request parameters.
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		async getUserAumPercentile(requestParameters = {}, options) {
+			return createRequestFunction(await localVarAxiosParamCreator.getUserAumPercentile(requestParameters.userId, requestParameters.userSecret, options), axios.default, BASE_PATH, configuration, {
+				authModes: ["commercialApiKey", "personalApiKey"],
+				requestSigningByAuthMode: {
+					"commercialApiKey": {
+						secretParameter: "consumerKey",
+						signedSecuritySchemes: ["PartnerSignature", "PartnerTimestamp"]
+					},
+					"personalApiKey": {
+						secretParameter: "consumerKey",
+						signedSecuritySchemes: ["PersonalSignature", "PersonalTimestamp"]
+					}
+				}
+			});
+		},
+		/**
 		* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).  This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.  Returns a list of balances, positions, and recent orders for the specified account.  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:   - If you do, this endpoint returns real-time data.   - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
 		* @summary List account holdings
 		* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
@@ -1573,6 +1666,16 @@ const AccountInformationApiFactory = function(configuration, basePath, axios$7)
 			return localVarFp.getUserAccountReturnRates(requestParameters, options).then((request) => request(axios$7, basePath));
 		},
 		/**
+		* Returns where the user\'s total assets sit within the distribution of a cohort of comparable users, as a coarse bucket plus an integer percentile.  The cohort is scoped to your own book: a user is only ever compared against your other users, never across SnapTrade customers. (Users on personal-use keys are the exception — they are compared against all other personal-use users, since a personal key has a single user and cannot form a distribution of its own.) The distribution is recomputed monthly, and `as_of` reports which month\'s distribution the placement came from.  `data` is `null` — a 200, not an error — when SnapTrade declines to place the user. That happens when the cohort is too small to publish a distribution, or when the user\'s own holdings are incomplete or stale (for example they hold a disabled connection). A placement computed from a partial view of a user\'s assets would understate them, so none is returned. 
+		* @summary Get the user\'s AUM percentile
+		* @param {AccountInformationApiGetUserAumPercentileRequest<TAuth>} requestParameters Request parameters.
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		getUserAumPercentile(requestParameters = {}, options) {
+			return localVarFp.getUserAumPercentile(requestParameters, options).then((request) => request(axios$7, basePath));
+		},
+		/**
 		* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).  This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.  Returns a list of balances, positions, and recent orders for the specified account.  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:   - If you do, this endpoint returns real-time data.   - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
 		* @summary List account holdings
 		* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
@@ -1712,6 +1815,17 @@ var AccountInformationApiGenerated = class extends BaseAPI {
 		return AccountInformationApiFp(this.configuration).getUserAccountReturnRates(requestParameters, options).then((request) => request(this.axios, this.basePath));
 	}
 	/**
+	* Returns where the user\'s total assets sit within the distribution of a cohort of comparable users, as a coarse bucket plus an integer percentile.  The cohort is scoped to your own book: a user is only ever compared against your other users, never across SnapTrade customers. (Users on personal-use keys are the exception — they are compared against all other personal-use users, since a personal key has a single user and cannot form a distribution of its own.) The distribution is recomputed monthly, and `as_of` reports which month\'s distribution the placement came from.  `data` is `null` — a 200, not an error — when SnapTrade declines to place the user. That happens when the cohort is too small to publish a distribution, or when the user\'s own holdings are incomplete or stale (for example they hold a disabled connection). A placement computed from a partial view of a user\'s assets would understate them, so none is returned. 
+	* @summary Get the user\'s AUM percentile
+	* @param {AccountInformationApiGetUserAumPercentileRequest<TAuth>} requestParameters Request parameters.
+	* @param {*} [options] Override http request option.
+	* @throws {RequiredError}
+	* @memberof AccountInformationApiGenerated
+	*/
+	getUserAumPercentile(requestParameters = {}, options) {
+		return AccountInformationApiFp(this.configuration).getUserAumPercentile(requestParameters, options).then((request) => request(this.axios, this.basePath));
+	}
+	/**
 	* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).  This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.  Returns a list of balances, positions, and recent orders for the specified account.  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:   - If you do, this endpoint returns real-time data.   - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
 	* @summary List account holdings
 	* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
@@ -2222,6 +2336,7 @@ const AuthenticationApiFp = function(configuration) {
 				connectionType: requestParameters.connectionType,
 				showCloseButton: requestParameters.showCloseButton,
 				darkMode: requestParameters.darkMode,
+				locale: requestParameters.locale,
 				connectionPortalVersion: requestParameters.connectionPortalVersion
 			};
 			return createRequestFunction(await localVarAxiosParamCreator.loginSnapTradeUser(snapTradeLoginUserRequestBody, requestParameters.userId, requestParameters.userSecret, options), axios.default, BASE_PATH, configuration, {
@@ -3749,7 +3864,7 @@ const ExperimentalEndpointsApiAxiosParamCreator = function(configuration) {
 			};
 		},
 		/**
-		* Experimental and subject to change without notice.  Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.  Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and market value live from the brokerage on each call.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. 
+		* Experimental and subject to change without notice.  Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.  Each item in the response carries a `kind` field (currently `investment` and `deposit` are implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date and total balance (`market_value` for `investment`, `balance` for `deposit`) live from the brokerage on each call, along with funding date for `investment` accounts.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. 
 		* @summary List accounts for a connection (discriminated union)
 		* @param {string} authorizationId 
 		* @param {string} [userId] 
@@ -4011,7 +4126,7 @@ const ExperimentalEndpointsApiFp = function(configuration) {
 			});
 		},
 		/**
-		* Experimental and subject to change without notice.  Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.  Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and market value live from the brokerage on each call.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. 
+		* Experimental and subject to change without notice.  Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.  Each item in the response carries a `kind` field (currently `investment` and `deposit` are implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date and total balance (`market_value` for `investment`, `balance` for `deposit`) live from the brokerage on each call, along with funding date for `investment` accounts.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. 
 		* @summary List accounts for a connection (discriminated union)
 		* @param {ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>} requestParameters Request parameters.
 		* @param {*} [options] Override http request option.
@@ -4114,7 +4229,7 @@ const ExperimentalEndpointsApiFactory = function(configuration, basePath, axios$
 			return localVarFp.getUserAccountRecentOrdersV2(requestParameters, options).then((request) => request(axios$3, basePath));
 		},
 		/**
-		* Experimental and subject to change without notice.  Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.  Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and market value live from the brokerage on each call.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. 
+		* Experimental and subject to change without notice.  Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.  Each item in the response carries a `kind` field (currently `investment` and `deposit` are implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date and total balance (`market_value` for `investment`, `balance` for `deposit`) live from the brokerage on each call, along with funding date for `investment` accounts.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. 
 		* @summary List accounts for a connection (discriminated union)
 		* @param {ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>} requestParameters Request parameters.
 		* @param {*} [options] Override http request option.
@@ -4197,7 +4312,7 @@ var ExperimentalEndpointsApiGenerated = class extends BaseAPI {
 		return ExperimentalEndpointsApiFp(this.configuration).getUserAccountRecentOrdersV2(requestParameters, options).then((request) => request(this.axios, this.basePath));
 	}
 	/**
-	* Experimental and subject to change without notice.  Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.  Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and market value live from the brokerage on each call.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. 
+	* Experimental and subject to change without notice.  Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.  Each item in the response carries a `kind` field (currently `investment` and `deposit` are implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.  On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date and total balance (`market_value` for `investment`, `balance` for `deposit`) live from the brokerage on each call, along with funding date for `investment` accounts.  On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. 
 	* @summary List accounts for a connection (discriminated union)
 	* @param {ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>} requestParameters Request parameters.
 	* @param {*} [options] Override http request option.
@@ -6996,7 +7111,7 @@ var Configuration = class {
 		}
 		this.basePath = param.basePath;
 		this.baseOptions = param.baseOptions ?? {};
-		this.userAgent = param.userAgent === void 0 ? "Konfig/12.1.3/typescript" : param.userAgent;
+		this.userAgent = param.userAgent === void 0 ? "Konfig/12.1.5/typescript" : param.userAgent;
 		this.formDataCtor = param.formDataCtor;
 	}
 	/**