snaptrade-typescript-sdk 12.2.17 → 12.2.18

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 page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) 
+		* 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)  The data may contain gaps and is best used for charting account value trends. It should not be relied on as a complete or exact record of historical account values. 
 		* @summary List historical account total value
 		* @param {string} accountId 
 		* @param {string} [userId] 
@@ -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 page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) 
+		* 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)  The data may contain gaps and is best used for charting account value trends. It should not be relied on as a complete or exact record of historical account values. 
 		* @summary List historical account total value
 		* @param {AccountInformationApiGetAccountBalanceHistoryRequest<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 page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) 
+		* 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)  The data may contain gaps and is best used for charting account value trends. It should not be relied on as a complete or exact record of historical account values. 
 		* @summary List historical account total value
 		* @param {AccountInformationApiGetAccountBalanceHistoryRequest<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 page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) 
+	* 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)  The data may contain gaps and is best used for charting account value trends. It should not be relied on as a complete or exact record of historical account values. 
 	* @summary List historical account total value
 	* @param {AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>} requestParameters Request parameters.
 	* @param {*} [options] Override http request option.
@@ -4132,6 +4132,84 @@ const ExperimentalEndpointsApiAxiosParamCreator = function(configuration) {
 				url: toPathString(localVarUrlObj),
 				options: localVarRequestOptions
 			};
+		},
+		/**
+		* **Beta.** Places a single-leg or multi-leg order using a common request format for equities, equity options, futures, and future options. This endpoint is experimental; breaking changes are possible during the experimental phase.  Equity and equity-option orders use the existing brokerage trading capabilities. Futures and future options are currently supported only on tastytrade. Order types, time in force, optional fields, and strategy combinations remain subject to brokerage support. See the [brokerage trading support page](https://support.snaptrade.com/brokerages).  An order may contain equity/option legs or future/future_option legs, but cannot mix those two families. Equity/option strategies must share the same underlying symbol. Each strategy is submitted as one brokerage order; unsupported strategies are never split into independent orders. Tastytrade supports single-leg outright futures and up to four future-option legs, and does not support multi-leg market orders.  All string choices use lower snake_case and are case-sensitive. Symbols retain their native format: equity tickers, OCC equity-option symbols, or the exact tastytrade BrokerageInstrument ticker for futures and future options, including any spaces.  A successful response contains only the brokerage order ID. Use the existing order endpoints to retrieve order details. 
+		* @summary Place a simple order (beta)
+		* @param {string} accountId The ID of the account to execute the trade on.
+		* @param {SimpleTradeForm} simpleTradeForm 
+		* @param {string} [userId] 
+		* @param {string} [userSecret] 
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		placeSimpleOrder: async (accountId, simpleTradeForm, userId, userSecret, options = {}) => {
+			assertParamExists("placeSimpleOrder", "accountId", accountId);
+			assertParamExists("placeSimpleOrder", "simpleTradeForm", simpleTradeForm);
+			const localVarPath = `/accounts/{accountId}/trading/simple`.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: "POST",
+				...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
+			};
+			localVarHeaderParameter["Content-Type"] = "application/json";
+			let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+			localVarRequestOptions.headers = {
+				...localVarHeaderParameter,
+				...headersFromBaseOptions,
+				...options.headers
+			};
+			requestBeforeHook({
+				requestBody: simpleTradeForm,
+				queryParameters: localVarQueryParameter,
+				requestConfig: localVarRequestOptions,
+				path: localVarPath,
+				configuration,
+				pathTemplate: "/accounts/{accountId}/trading/simple",
+				httpMethod: "POST",
+				operationAuth: localVarOperationAuth
+			});
+			localVarRequestOptions.data = serializeDataIfNeeded(simpleTradeForm, localVarRequestOptions, configuration);
+			setSearchParams(localVarUrlObj, localVarQueryParameter);
+			return {
+				url: toPathString(localVarUrlObj),
+				options: localVarRequestOptions
+			};
 		}
 	};
 };
@@ -4329,6 +4407,41 @@ const ExperimentalEndpointsApiFp = function(configuration) {
 					}
 				}
 			});
+		},
+		/**
+		* **Beta.** Places a single-leg or multi-leg order using a common request format for equities, equity options, futures, and future options. This endpoint is experimental; breaking changes are possible during the experimental phase.  Equity and equity-option orders use the existing brokerage trading capabilities. Futures and future options are currently supported only on tastytrade. Order types, time in force, optional fields, and strategy combinations remain subject to brokerage support. See the [brokerage trading support page](https://support.snaptrade.com/brokerages).  An order may contain equity/option legs or future/future_option legs, but cannot mix those two families. Equity/option strategies must share the same underlying symbol. Each strategy is submitted as one brokerage order; unsupported strategies are never split into independent orders. Tastytrade supports single-leg outright futures and up to four future-option legs, and does not support multi-leg market orders.  All string choices use lower snake_case and are case-sensitive. Symbols retain their native format: equity tickers, OCC equity-option symbols, or the exact tastytrade BrokerageInstrument ticker for futures and future options, including any spaces.  A successful response contains only the brokerage order ID. Use the existing order endpoints to retrieve order details. 
+		* @summary Place a simple order (beta)
+		* @param {ExperimentalEndpointsApiPlaceSimpleOrderRequest<TAuth>} requestParameters Request parameters.
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		async placeSimpleOrder(...args) {
+			const [requestParameters = {}, options] = args;
+			const simpleTradeForm = {
+				order_type: requestParameters.order_type,
+				time_in_force: requestParameters.time_in_force,
+				legs: requestParameters.legs,
+				limit_price: requestParameters.limit_price,
+				stop_price: requestParameters.stop_price,
+				price_effect: requestParameters.price_effect,
+				client_order_id: requestParameters.client_order_id,
+				expiry_date: requestParameters.expiry_date,
+				notional_value: requestParameters.notional_value,
+				trading_session: requestParameters.trading_session
+			};
+			return createRequestFunction(await localVarAxiosParamCreator.placeSimpleOrder(requestParameters.accountId, simpleTradeForm, 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"]
+					}
+				}
+			});
 		}
 	};
 };
@@ -4417,6 +4530,16 @@ const ExperimentalEndpointsApiFactory = function(configuration, basePath, axios$
 		*/
 		listSubscriptions(...args) {
 			return localVarFp.listSubscriptions(...args).then((request) => request(axios$4, basePath));
+		},
+		/**
+		* **Beta.** Places a single-leg or multi-leg order using a common request format for equities, equity options, futures, and future options. This endpoint is experimental; breaking changes are possible during the experimental phase.  Equity and equity-option orders use the existing brokerage trading capabilities. Futures and future options are currently supported only on tastytrade. Order types, time in force, optional fields, and strategy combinations remain subject to brokerage support. See the [brokerage trading support page](https://support.snaptrade.com/brokerages).  An order may contain equity/option legs or future/future_option legs, but cannot mix those two families. Equity/option strategies must share the same underlying symbol. Each strategy is submitted as one brokerage order; unsupported strategies are never split into independent orders. Tastytrade supports single-leg outright futures and up to four future-option legs, and does not support multi-leg market orders.  All string choices use lower snake_case and are case-sensitive. Symbols retain their native format: equity tickers, OCC equity-option symbols, or the exact tastytrade BrokerageInstrument ticker for futures and future options, including any spaces.  A successful response contains only the brokerage order ID. Use the existing order endpoints to retrieve order details. 
+		* @summary Place a simple order (beta)
+		* @param {ExperimentalEndpointsApiPlaceSimpleOrderRequest<TAuth>} requestParameters Request parameters.
+		* @param {*} [options] Override http request option.
+		* @throws {RequiredError}
+		*/
+		placeSimpleOrder(...args) {
+			return localVarFp.placeSimpleOrder(...args).then((request) => request(axios$4, basePath));
 		}
 	};
 };
@@ -4514,6 +4637,17 @@ var ExperimentalEndpointsApiGenerated = class extends BaseAPI {
 	listSubscriptions(...args) {
 		return ExperimentalEndpointsApiFp(this.configuration).listSubscriptions(...args).then((request) => request(this.axios, this.basePath));
 	}
+	/**
+	* **Beta.** Places a single-leg or multi-leg order using a common request format for equities, equity options, futures, and future options. This endpoint is experimental; breaking changes are possible during the experimental phase.  Equity and equity-option orders use the existing brokerage trading capabilities. Futures and future options are currently supported only on tastytrade. Order types, time in force, optional fields, and strategy combinations remain subject to brokerage support. See the [brokerage trading support page](https://support.snaptrade.com/brokerages).  An order may contain equity/option legs or future/future_option legs, but cannot mix those two families. Equity/option strategies must share the same underlying symbol. Each strategy is submitted as one brokerage order; unsupported strategies are never split into independent orders. Tastytrade supports single-leg outright futures and up to four future-option legs, and does not support multi-leg market orders.  All string choices use lower snake_case and are case-sensitive. Symbols retain their native format: equity tickers, OCC equity-option symbols, or the exact tastytrade BrokerageInstrument ticker for futures and future options, including any spaces.  A successful response contains only the brokerage order ID. Use the existing order endpoints to retrieve order details. 
+	* @summary Place a simple order (beta)
+	* @param {ExperimentalEndpointsApiPlaceSimpleOrderRequest<TAuth>} requestParameters Request parameters.
+	* @param {*} [options] Override http request option.
+	* @throws {RequiredError}
+	* @memberof ExperimentalEndpointsApiGenerated
+	*/
+	placeSimpleOrder(...args) {
+		return ExperimentalEndpointsApiFp(this.configuration).placeSimpleOrder(...args).then((request) => request(this.axios, this.basePath));
+	}
 };
 //#endregion
 //#region api/experimental-endpoints-api.ts
@@ -7383,7 +7517,7 @@ var Configuration = class {
 		}
 		this.basePath = param.basePath;
 		this.baseOptions = param.baseOptions ?? {};
-		this.userAgent = param.userAgent === void 0 ? "Konfig/12.2.17/typescript" : param.userAgent;
+		this.userAgent = param.userAgent === void 0 ? "Konfig/12.2.18/typescript" : param.userAgent;
 		this.formDataCtor = param.formDataCtor;
 	}
 	/**