snaptrade-typescript-sdk 9.0.101 → 9.0.103

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.101-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.101)
+[![npm](https://img.shields.io/badge/npm-v9.0.103-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.103)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -2069,7 +2069,7 @@ The universal symbol ID of the security to trade. Must be \\\'null\\\' if `symbo
 
 ##### symbol: `string`<a id="symbol-string"></a>
 
-The security\\\'s trading ticker symbol. This currently supports stock symbols and Options symbols in the 21 character OCC format. For example \\\"AAPL  131124C00240000\\\" represents a call option on AAPL expiring on 2024-11-13 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format). If \\\'symbol\\\' is provided, then \\\'universal_symbol_id\\\' must be \\\'null\\\'.
+The security\\\'s trading ticker symbol. This currently supports stock symbols and Options symbols in the 21 character OCC format. For example `AAPL  131124C00240000` represents a call option on AAPL expiring on 2024-11-13 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format). If \\\'symbol\\\' is provided, then \\\'universal_symbol_id\\\' must be \\\'null\\\'.
 
 ##### price: `number`<a id="price-number"></a>
 

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

@@ -9,12 +9,12 @@ import { ManualTradeFormBracket } from '../models';
 import { ManualTradeFormWithOptions } from '../models';
 import { ManualTradeReplaceForm } from '../models';
 import { MlegOrderResponse } from '../models';
+import { MlegTradeForm } from '../models';
 import { OrderUpdatedResponse } from '../models';
+import { SimpleOrderForm } from '../models';
 import { SimpleOrderPreview } from '../models';
 import { SymbolsQuotesInner } from '../models';
 import { TradingCancelUserAccountOrderRequest } from '../models';
-import { TradingPlaceMlegOrderRequest } from '../models';
-import { TradingPlaceSimpleOrderRequest } from '../models';
 import { TradingSearchCryptocurrencyPairInstruments200Response } from '../models';
 import { ValidatedTradeBody } from '../models';
 /**
@@ -104,11 +104,11 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId
-     * @param {TradingPlaceMlegOrderRequest} tradingPlaceMlegOrderRequest
+     * @param {MlegTradeForm} mlegTradeForm
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    placeMlegOrder: (userId: string, userSecret: string, accountId: string, tradingPlaceMlegOrderRequest: TradingPlaceMlegOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    placeMlegOrder: (userId: string, userSecret: string, accountId: string, mlegTradeForm: MlegTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
      * @summary Place checked order
@@ -126,22 +126,22 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId
-     * @param {TradingPlaceSimpleOrderRequest} tradingPlaceSimpleOrderRequest
+     * @param {SimpleOrderForm} simpleOrderForm
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    placeSimpleOrder: (userId: string, userSecret: string, accountId: string, tradingPlaceSimpleOrderRequest: TradingPlaceSimpleOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    placeSimpleOrder: (userId: string, userSecret: string, accountId: string, simpleOrderForm: SimpleOrderForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Previews an order using the specified account.
      * @summary Preview order
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId
-     * @param {TradingPlaceSimpleOrderRequest} tradingPlaceSimpleOrderRequest
+     * @param {SimpleOrderForm} simpleOrderForm
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    previewSimpleOrder: (userId: string, userSecret: string, accountId: string, tradingPlaceSimpleOrderRequest: TradingPlaceSimpleOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    previewSimpleOrder: (userId: string, userSecret: string, accountId: string, simpleOrderForm: SimpleOrderForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
      * @summary Replaces an order with a new one
@@ -598,7 +598,7 @@ export type TradingApiPlaceMlegOrderRequest = {
     * @memberof TradingApiPlaceMlegOrder
     */
     readonly accountId: string;
-} & TradingPlaceMlegOrderRequest;
+} & MlegTradeForm;
 /**
  * Request parameters for placeOrder operation in TradingApi.
  * @export
@@ -648,7 +648,7 @@ export type TradingApiPlaceSimpleOrderRequest = {
     * @memberof TradingApiPlaceSimpleOrder
     */
     readonly accountId: string;
-} & TradingPlaceSimpleOrderRequest;
+} & SimpleOrderForm;
 /**
  * Request parameters for previewSimpleOrder operation in TradingApi.
  * @export
@@ -673,7 +673,7 @@ export type TradingApiPreviewSimpleOrderRequest = {
     * @memberof TradingApiPreviewSimpleOrder
     */
     readonly accountId: string;
-} & TradingPlaceSimpleOrderRequest;
+} & SimpleOrderForm;
 /**
  * Request parameters for replaceOrder operation in TradingApi.
  * @export

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

@@ -460,19 +460,19 @@ const TradingApiAxiosParamCreator = function (configuration) {
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId
-         * @param {TradingPlaceMlegOrderRequest} tradingPlaceMlegOrderRequest
+         * @param {MlegTradeForm} mlegTradeForm
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        placeMlegOrder: (userId, userSecret, accountId, tradingPlaceMlegOrderRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        placeMlegOrder: (userId, userSecret, accountId, mlegTradeForm, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'userId' is not null or undefined
             (0, common_1.assertParamExists)('placeMlegOrder', 'userId', userId);
             // verify required parameter 'userSecret' is not null or undefined
             (0, common_1.assertParamExists)('placeMlegOrder', 'userSecret', userSecret);
             // verify required parameter 'accountId' is not null or undefined
             (0, common_1.assertParamExists)('placeMlegOrder', 'accountId', accountId);
-            // verify required parameter 'tradingPlaceMlegOrderRequest' is not null or undefined
-            (0, common_1.assertParamExists)('placeMlegOrder', 'tradingPlaceMlegOrderRequest', tradingPlaceMlegOrderRequest);
+            // verify required parameter 'mlegTradeForm' is not null or undefined
+            (0, common_1.assertParamExists)('placeMlegOrder', 'mlegTradeForm', mlegTradeForm);
             const localVarPath = `/accounts/{accountId}/trading/options`
                 .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -500,7 +500,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
             (0, requestBeforeHook_1.requestBeforeHook)({
-                requestBody: tradingPlaceMlegOrderRequest,
+                requestBody: mlegTradeForm,
                 queryParameters: localVarQueryParameter,
                 requestConfig: localVarRequestOptions,
                 path: localVarPath,
@@ -508,7 +508,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
                 pathTemplate: '/accounts/{accountId}/trading/options',
                 httpMethod: 'POST'
             });
-            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(tradingPlaceMlegOrderRequest, localVarRequestOptions, configuration);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(mlegTradeForm, localVarRequestOptions, configuration);
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             return {
                 url: (0, common_1.toPathString)(localVarUrlObj),
@@ -580,19 +580,19 @@ const TradingApiAxiosParamCreator = function (configuration) {
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId
-         * @param {TradingPlaceSimpleOrderRequest} tradingPlaceSimpleOrderRequest
+         * @param {SimpleOrderForm} simpleOrderForm
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        placeSimpleOrder: (userId, userSecret, accountId, tradingPlaceSimpleOrderRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        placeSimpleOrder: (userId, userSecret, accountId, simpleOrderForm, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'userId' is not null or undefined
             (0, common_1.assertParamExists)('placeSimpleOrder', 'userId', userId);
             // verify required parameter 'userSecret' is not null or undefined
             (0, common_1.assertParamExists)('placeSimpleOrder', 'userSecret', userSecret);
             // verify required parameter 'accountId' is not null or undefined
             (0, common_1.assertParamExists)('placeSimpleOrder', 'accountId', accountId);
-            // verify required parameter 'tradingPlaceSimpleOrderRequest' is not null or undefined
-            (0, common_1.assertParamExists)('placeSimpleOrder', 'tradingPlaceSimpleOrderRequest', tradingPlaceSimpleOrderRequest);
+            // verify required parameter 'simpleOrderForm' is not null or undefined
+            (0, common_1.assertParamExists)('placeSimpleOrder', 'simpleOrderForm', simpleOrderForm);
             const localVarPath = `/accounts/{accountId}/trading/simple`
                 .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -620,7 +620,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
             (0, requestBeforeHook_1.requestBeforeHook)({
-                requestBody: tradingPlaceSimpleOrderRequest,
+                requestBody: simpleOrderForm,
                 queryParameters: localVarQueryParameter,
                 requestConfig: localVarRequestOptions,
                 path: localVarPath,
@@ -628,7 +628,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
                 pathTemplate: '/accounts/{accountId}/trading/simple',
                 httpMethod: 'POST'
             });
-            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(tradingPlaceSimpleOrderRequest, localVarRequestOptions, configuration);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(simpleOrderForm, localVarRequestOptions, configuration);
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             return {
                 url: (0, common_1.toPathString)(localVarUrlObj),
@@ -641,19 +641,19 @@ const TradingApiAxiosParamCreator = function (configuration) {
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId
-         * @param {TradingPlaceSimpleOrderRequest} tradingPlaceSimpleOrderRequest
+         * @param {SimpleOrderForm} simpleOrderForm
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        previewSimpleOrder: (userId, userSecret, accountId, tradingPlaceSimpleOrderRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        previewSimpleOrder: (userId, userSecret, accountId, simpleOrderForm, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'userId' is not null or undefined
             (0, common_1.assertParamExists)('previewSimpleOrder', 'userId', userId);
             // verify required parameter 'userSecret' is not null or undefined
             (0, common_1.assertParamExists)('previewSimpleOrder', 'userSecret', userSecret);
             // verify required parameter 'accountId' is not null or undefined
             (0, common_1.assertParamExists)('previewSimpleOrder', 'accountId', accountId);
-            // verify required parameter 'tradingPlaceSimpleOrderRequest' is not null or undefined
-            (0, common_1.assertParamExists)('previewSimpleOrder', 'tradingPlaceSimpleOrderRequest', tradingPlaceSimpleOrderRequest);
+            // verify required parameter 'simpleOrderForm' is not null or undefined
+            (0, common_1.assertParamExists)('previewSimpleOrder', 'simpleOrderForm', simpleOrderForm);
             const localVarPath = `/accounts/{accountId}/trading/simple/preview`
                 .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -681,7 +681,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
             (0, requestBeforeHook_1.requestBeforeHook)({
-                requestBody: tradingPlaceSimpleOrderRequest,
+                requestBody: simpleOrderForm,
                 queryParameters: localVarQueryParameter,
                 requestConfig: localVarRequestOptions,
                 path: localVarPath,
@@ -689,7 +689,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
                 pathTemplate: '/accounts/{accountId}/trading/simple/preview',
                 httpMethod: 'POST'
             });
-            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(tradingPlaceSimpleOrderRequest, localVarRequestOptions, configuration);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(simpleOrderForm, localVarRequestOptions, configuration);
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             return {
                 url: (0, common_1.toPathString)(localVarUrlObj),
@@ -972,14 +972,14 @@ const TradingApiFp = function (configuration) {
          */
         placeMlegOrder(requestParameters, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const tradingPlaceMlegOrderRequest = {
+                const mlegTradeForm = {
                     order_type: requestParameters.order_type,
                     time_in_force: requestParameters.time_in_force,
                     limit_price: requestParameters.limit_price,
                     stop_price: requestParameters.stop_price,
                     legs: requestParameters.legs
                 };
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.placeMlegOrder(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, tradingPlaceMlegOrderRequest, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.placeMlegOrder(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, mlegTradeForm, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -1008,7 +1008,7 @@ const TradingApiFp = function (configuration) {
          */
         placeSimpleOrder(requestParameters, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const tradingPlaceSimpleOrderRequest = {
+                const simpleOrderForm = {
                     instrument: requestParameters.instrument,
                     side: requestParameters.side,
                     type: requestParameters.type,
@@ -1019,7 +1019,7 @@ const TradingApiFp = function (configuration) {
                     post_only: requestParameters.post_only,
                     expiration_date: requestParameters.expiration_date
                 };
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.placeSimpleOrder(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, tradingPlaceSimpleOrderRequest, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.placeSimpleOrder(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, simpleOrderForm, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -1032,7 +1032,7 @@ const TradingApiFp = function (configuration) {
          */
         previewSimpleOrder(requestParameters, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const tradingPlaceSimpleOrderRequest = {
+                const simpleOrderForm = {
                     instrument: requestParameters.instrument,
                     side: requestParameters.side,
                     type: requestParameters.type,
@@ -1043,7 +1043,7 @@ const TradingApiFp = function (configuration) {
                     post_only: requestParameters.post_only,
                     expiration_date: requestParameters.expiration_date
                 };
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.previewSimpleOrder(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, tradingPlaceSimpleOrderRequest, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.previewSimpleOrder(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, simpleOrderForm, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },