snaptrade-typescript-sdk 12.2.16 → 12.2.17

package/dist/index.mjs

@@ -3674,6 +3674,79 @@ const ExperimentalEndpointsApiAxiosParamCreator = function(configuration) {
 			};
 		},
 		/**
+		* Experimental and subject to change without notice.  Returns the specified account for the authenticated user, using the `kind`-discriminated account shape. Use the `kind` discriminator to determine the shape of the account, which can be an investment, deposit, or line of credit account.  On Pay as you Go / Real-time, this endpoint refreshes the account\'s opening date and total net value (`net_value`) live from the institution 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 institution. 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.  If the connection has become disabled, it can no longer access the latest data from the institution, 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 Get account details
+		* @param {string} accountId 
+		* @param {string} [userId] 
+		* @param {string} [userSecret] 
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		getAccountDetails: async (accountId, userId, userSecret, options = {}) => {
+			assertParamExists("getAccountDetails", "accountId", accountId);
+			const localVarPath = `/accounts/{accountId}/details`.replace(`{accountId}`, encodeURIComponent(String(accountId !== void 0 ? accountId : `-accountId-`)));
+			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: "/accounts/{accountId}/details",
+				httpMethod: "GET",
+				operationAuth: localVarOperationAuth
+			});
+			setSearchParams(localVarUrlObj, localVarQueryParameter);
+			return {
+				url: toPathString(localVarUrlObj),
+				options: localVarRequestOptions
+			};
+		},
+		/**
 		* Returns the detail of a single order using the brokerage order ID provided as a path parameter.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
 		* @summary Get account order detail (V2)
 		* @param {string} accountId 
@@ -3901,6 +3974,77 @@ const ExperimentalEndpointsApiAxiosParamCreator = function(configuration) {
 			};
 		},
 		/**
+		* Experimental and subject to change without notice.  Returns all accounts across all connections known to SnapTrade for the authenticated user.  The `results` list can contain multiple account kinds in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the shape for each account.  This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user\'s connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). 
+		* @summary List all user accounts
+		* @param {string} [userId] 
+		* @param {string} [userSecret] 
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		listAllUserAccounts: async (userId, userSecret, options = {}) => {
+			const localVarPath = `/accounts/all`;
+			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: "/accounts/all",
+				httpMethod: "GET",
+				operationAuth: localVarOperationAuth
+			});
+			setSearchParams(localVarUrlObj, localVarQueryParameter);
+			return {
+				url: toPathString(localVarUrlObj),
+				options: localVarRequestOptions
+			};
+		},
+		/**
 		* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
 		* @summary List active Trade Detection subscriptions
 		* @param {*} [options] Override http request option.
@@ -4026,6 +4170,29 @@ const ExperimentalEndpointsApiFp = function(configuration) {
 			});
 		},
 		/**
+		* Experimental and subject to change without notice.  Returns the specified account for the authenticated user, using the `kind`-discriminated account shape. Use the `kind` discriminator to determine the shape of the account, which can be an investment, deposit, or line of credit account.  On Pay as you Go / Real-time, this endpoint refreshes the account\'s opening date and total net value (`net_value`) live from the institution 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 institution. 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.  If the connection has become disabled, it can no longer access the latest data from the institution, 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 Get account details
+		* @param {ExperimentalEndpointsApiGetAccountDetailsRequest<TAuth>} requestParameters Request parameters.
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		async getAccountDetails(...args) {
+			const [requestParameters = {}, options] = args;
+			return createRequestFunction(await localVarAxiosParamCreator.getAccountDetails(requestParameters.accountId, requestParameters.userId, requestParameters.userSecret, options), globalAxios, BASE_PATH, configuration, {
+				authModes: ["commercialApiKey", "personalApiKey"],
+				requestSigningByAuthMode: {
+					"commercialApiKey": {
+						secretParameter: "consumerKey",
+						signedSecuritySchemes: ["PartnerSignature", "PartnerTimestamp"]
+					},
+					"personalApiKey": {
+						secretParameter: "consumerKey",
+						signedSecuritySchemes: ["PersonalSignature", "PersonalTimestamp"]
+					}
+				}
+			});
+		},
+		/**
 		* Returns the detail of a single order using the brokerage order ID provided as a path parameter.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
 		* @summary Get account order detail (V2)
 		* @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request<TAuth>} requestParameters Request parameters.
@@ -4095,6 +4262,29 @@ const ExperimentalEndpointsApiFp = function(configuration) {
 			});
 		},
 		/**
+		* Experimental and subject to change without notice.  Returns all accounts across all connections known to SnapTrade for the authenticated user.  The `results` list can contain multiple account kinds in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the shape for each account.  This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user\'s connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). 
+		* @summary List all user accounts
+		* @param {ExperimentalEndpointsApiListAllUserAccountsRequest<TAuth>} requestParameters Request parameters.
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		async listAllUserAccounts(...args) {
+			const [requestParameters = {}, options] = args;
+			return createRequestFunction(await localVarAxiosParamCreator.listAllUserAccounts(requestParameters.userId, requestParameters.userSecret, options), globalAxios, BASE_PATH, configuration, {
+				authModes: ["commercialApiKey", "personalApiKey"],
+				requestSigningByAuthMode: {
+					"commercialApiKey": {
+						secretParameter: "consumerKey",
+						signedSecuritySchemes: ["PartnerSignature", "PartnerTimestamp"]
+					},
+					"personalApiKey": {
+						secretParameter: "consumerKey",
+						signedSecuritySchemes: ["PersonalSignature", "PersonalTimestamp"]
+					}
+				}
+			});
+		},
+		/**
 		* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
 		* @summary List active Trade Detection subscriptions
 		* @param {*} [options] Override http request option.
@@ -4146,6 +4336,16 @@ const ExperimentalEndpointsApiFactory = function(configuration, basePath, axios)
 			return localVarFp.cancelSubscription(...args).then((request) => request(axios, basePath));
 		},
 		/**
+		* Experimental and subject to change without notice.  Returns the specified account for the authenticated user, using the `kind`-discriminated account shape. Use the `kind` discriminator to determine the shape of the account, which can be an investment, deposit, or line of credit account.  On Pay as you Go / Real-time, this endpoint refreshes the account\'s opening date and total net value (`net_value`) live from the institution 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 institution. 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.  If the connection has become disabled, it can no longer access the latest data from the institution, 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 Get account details
+		* @param {ExperimentalEndpointsApiGetAccountDetailsRequest<TAuth>} requestParameters Request parameters.
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		getAccountDetails(...args) {
+			return localVarFp.getAccountDetails(...args).then((request) => request(axios, basePath));
+		},
+		/**
 		* Returns the detail of a single order using the brokerage order ID provided as a path parameter.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
 		* @summary Get account order detail (V2)
 		* @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request<TAuth>} requestParameters Request parameters.
@@ -4176,6 +4376,16 @@ const ExperimentalEndpointsApiFactory = function(configuration, basePath, axios)
 			return localVarFp.getUserAccountRecentOrdersV2(...args).then((request) => request(axios, basePath));
 		},
 		/**
+		* Experimental and subject to change without notice.  Returns all accounts across all connections known to SnapTrade for the authenticated user.  The `results` list can contain multiple account kinds in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the shape for each account.  This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user\'s connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). 
+		* @summary List all user accounts
+		* @param {ExperimentalEndpointsApiListAllUserAccountsRequest<TAuth>} requestParameters Request parameters.
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		listAllUserAccounts(...args) {
+			return localVarFp.listAllUserAccounts(...args).then((request) => request(axios, basePath));
+		},
+		/**
 		* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
 		* @summary List active Trade Detection subscriptions
 		* @param {*} [options] Override http request option.
@@ -4216,6 +4426,17 @@ var ExperimentalEndpointsApiGenerated = class extends BaseAPI {
 		return ExperimentalEndpointsApiFp(this.configuration).cancelSubscription(...args).then((request) => request(this.axios, this.basePath));
 	}
 	/**
+	* Experimental and subject to change without notice.  Returns the specified account for the authenticated user, using the `kind`-discriminated account shape. Use the `kind` discriminator to determine the shape of the account, which can be an investment, deposit, or line of credit account.  On Pay as you Go / Real-time, this endpoint refreshes the account\'s opening date and total net value (`net_value`) live from the institution 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 institution. 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.  If the connection has become disabled, it can no longer access the latest data from the institution, 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 Get account details
+	* @param {ExperimentalEndpointsApiGetAccountDetailsRequest<TAuth>} requestParameters Request parameters.
+	* @param {*} [options] Override http request option.
+	* @throws {RequiredError}
+	* @memberof ExperimentalEndpointsApiGenerated
+	*/
+	getAccountDetails(...args) {
+		return ExperimentalEndpointsApiFp(this.configuration).getAccountDetails(...args).then((request) => request(this.axios, this.basePath));
+	}
+	/**
 	* Returns the detail of a single order using the brokerage order ID provided as a path parameter.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
 	* @summary Get account order detail (V2)
 	* @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request<TAuth>} requestParameters Request parameters.
@@ -4249,6 +4470,17 @@ var ExperimentalEndpointsApiGenerated = class extends BaseAPI {
 		return ExperimentalEndpointsApiFp(this.configuration).getUserAccountRecentOrdersV2(...args).then((request) => request(this.axios, this.basePath));
 	}
 	/**
+	* Experimental and subject to change without notice.  Returns all accounts across all connections known to SnapTrade for the authenticated user.  The `results` list can contain multiple account kinds in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the shape for each account.  This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user\'s connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). 
+	* @summary List all user accounts
+	* @param {ExperimentalEndpointsApiListAllUserAccountsRequest<TAuth>} requestParameters Request parameters.
+	* @param {*} [options] Override http request option.
+	* @throws {RequiredError}
+	* @memberof ExperimentalEndpointsApiGenerated
+	*/
+	listAllUserAccounts(...args) {
+		return ExperimentalEndpointsApiFp(this.configuration).listAllUserAccounts(...args).then((request) => request(this.axios, this.basePath));
+	}
+	/**
 	* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
 	* @summary List active Trade Detection subscriptions
 	* @param {*} [options] Override http request option.
@@ -7127,7 +7359,7 @@ var Configuration = class {
 		}
 		this.basePath = param.basePath;
 		this.baseOptions = param.baseOptions ?? {};
-		this.userAgent = param.userAgent === void 0 ? "Konfig/12.2.16/typescript" : param.userAgent;
+		this.userAgent = param.userAgent === void 0 ? "Konfig/12.2.17/typescript" : param.userAgent;
 		this.formDataCtor = param.formDataCtor;
 	}
 	/**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "snaptrade-typescript-sdk",
-  "version": "12.2.16",
+  "version": "12.2.17",
   "description": "Client for SnapTrade",
   "author": "Konfig",
   "engines": {