snaptrade-typescript-sdk 9.0.47 → 9.0.49

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.47-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.47)
+[![npm](https://img.shields.io/badge/npm-v9.0.49-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.49)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -1559,7 +1559,7 @@ Unique identifier for the connected brokerage account. This is the UUID used to
 
 ##### action: [`ActionStrict`](./models/action-strict.ts)<a id="action-actionstrictmodelsaction-strictts"></a>
 
-The action describes the intent or side of a trade. This is either `BUY` or `SELL`
+The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
 
 ##### universal_symbol_id: `string`<a id="universal_symbol_id-string"></a>
 
@@ -1665,6 +1665,7 @@ const placeForceOrderResponse = await snaptrade.trading.placeForceOrder({
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   action: "BUY",
   universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+  symbol: "AAPL  131124C00240000",
   order_type: "Market",
   time_in_force: "FOK",
   price: 31.33,
@@ -1679,13 +1680,9 @@ const placeForceOrderResponse = await snaptrade.trading.placeForceOrder({
 
 Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
 
-##### action: [`ActionStrict`](./models/action-strict.ts)<a id="action-actionstrictmodelsaction-strictts"></a>
-
-The action describes the intent or side of a trade. This is either `BUY` or `SELL`
-
-##### universal_symbol_id: `string`<a id="universal_symbol_id-string"></a>
+##### action: [`ActionStrictWithOptions`](./models/action-strict-with-options.ts)<a id="action-actionstrictwithoptionsmodelsaction-strict-with-optionsts"></a>
 
-Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options.
 
 ##### order_type: [`OrderTypeStrict`](./models/order-type-strict.ts)<a id="order_type-ordertypestrictmodelsorder-type-strictts"></a>
 
@@ -1699,6 +1696,14 @@ The Time in Force type for the order. This field indicates how long the order wi
 
 ##### userSecret: `string`<a id="usersecret-string"></a>
 
+##### universal_symbol_id: [`string`](./models/model-string.ts)<a id="universal_symbol_id-stringmodelsmodel-stringts"></a>
+
+The universal symbol ID of the security to trade. Must be \\\'null\\\' if `symbol` is provided, otherwise must be provided.
+
+##### symbol: `string`<a id="symbol-string"></a>
+
+The security\\\'s trading ticker symbol. This currently only support 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>
 
 The limit price for `Limit` and `StopLimit` orders.
@@ -1709,6 +1714,8 @@ The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
 
 ##### units: [`number`](./models/number.ts)<a id="units-numbermodelsnumberts"></a>
 
+For Equity orders, this represents the number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. If placing an Option order, this field represents the number of contracts to buy or sell. (e.g., 1 contract = 100 shares).
+
 ##### notional_value: [`ManualTradeFormNotionalValue`](./models/manual-trade-form-notional-value.ts)<a id="notional_value-manualtradeformnotionalvaluemodelsmanual-trade-form-notional-valuets"></a>
 
 #### 🔄 Return<a id="🔄-return"></a>
@@ -1819,7 +1826,7 @@ Optional comma separated list of SnapTrade Connection (Brokerage Authorization)
 
 ##### type: `string`<a id="type-string"></a>
 
-Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.  
+Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event. 
 
 #### 🔄 Return<a id="🔄-return"></a>
 

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

@@ -4,6 +4,7 @@ import { RequestArgs, BaseAPI } from '../base';
 import { AccountOrderRecord } from '../models';
 import { ManualTradeAndImpact } from '../models';
 import { ManualTradeForm } from '../models';
+import { ManualTradeFormWithOptions } from '../models';
 import { SymbolsQuotesInner } from '../models';
 import { TradingCancelUserAccountOrderRequest } from '../models';
 import { ValidatedTradeBody } from '../models';
@@ -50,11 +51,11 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
      * @summary Place order
      * @param {string} userId
      * @param {string} userSecret
-     * @param {ManualTradeForm} manualTradeForm
+     * @param {ManualTradeFormWithOptions} manualTradeFormWithOptions
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    placeForceOrder: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    placeForceOrder: (userId: string, userSecret: string, manualTradeFormWithOptions: ManualTradeFormWithOptions, 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
@@ -258,7 +259,7 @@ export type TradingApiPlaceForceOrderRequest = {
     * @memberof TradingApiPlaceForceOrder
     */
     readonly userSecret: string;
-} & ManualTradeForm;
+} & ManualTradeFormWithOptions;
 /**
  * Request parameters for placeOrder operation in TradingApi.
  * @export

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

@@ -223,17 +223,17 @@ const TradingApiAxiosParamCreator = function (configuration) {
          * @summary Place order
          * @param {string} userId
          * @param {string} userSecret
-         * @param {ManualTradeForm} manualTradeForm
+         * @param {ManualTradeFormWithOptions} manualTradeFormWithOptions
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        placeForceOrder: (userId, userSecret, manualTradeForm, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        placeForceOrder: (userId, userSecret, manualTradeFormWithOptions, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'userId' is not null or undefined
             (0, common_1.assertParamExists)('placeForceOrder', 'userId', userId);
             // verify required parameter 'userSecret' is not null or undefined
             (0, common_1.assertParamExists)('placeForceOrder', 'userSecret', userSecret);
-            // verify required parameter 'manualTradeForm' is not null or undefined
-            (0, common_1.assertParamExists)('placeForceOrder', 'manualTradeForm', manualTradeForm);
+            // verify required parameter 'manualTradeFormWithOptions' is not null or undefined
+            (0, common_1.assertParamExists)('placeForceOrder', 'manualTradeFormWithOptions', manualTradeFormWithOptions);
             const localVarPath = `/trade/place`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -260,7 +260,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: manualTradeForm,
+                requestBody: manualTradeFormWithOptions,
                 queryParameters: localVarQueryParameter,
                 requestConfig: localVarRequestOptions,
                 path: localVarPath,
@@ -268,7 +268,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
                 pathTemplate: '/trade/place',
                 httpMethod: 'POST'
             });
-            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(manualTradeForm, localVarRequestOptions, configuration);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(manualTradeFormWithOptions, localVarRequestOptions, configuration);
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             return {
                 url: (0, common_1.toPathString)(localVarUrlObj),
@@ -406,10 +406,11 @@ const TradingApiFp = function (configuration) {
          */
         placeForceOrder(requestParameters, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const manualTradeForm = {
+                const manualTradeFormWithOptions = {
                     account_id: requestParameters.account_id,
                     action: requestParameters.action,
                     universal_symbol_id: requestParameters.universal_symbol_id,
+                    symbol: requestParameters.symbol,
                     order_type: requestParameters.order_type,
                     time_in_force: requestParameters.time_in_force,
                     price: requestParameters.price,
@@ -417,7 +418,7 @@ const TradingApiFp = function (configuration) {
                     units: requestParameters.units,
                     notional_value: requestParameters.notional_value
                 };
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.placeForceOrder(requestParameters.userId, requestParameters.userSecret, manualTradeForm, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.placeForceOrder(requestParameters.userId, requestParameters.userSecret, manualTradeFormWithOptions, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },

package/dist/api/transactions-and-reporting-api-generated.d.ts

@@ -17,7 +17,7 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
      * @param {string | Date} [endDate] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
      * @param {string} [accounts] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
      * @param {string} [brokerageAuthorizations] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-     * @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.
+     * @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -127,7 +127,7 @@ export type TransactionsAndReportingApiGetActivitiesRequest = {
     */
     readonly brokerageAuthorizations?: string;
     /**
-    * Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.
+    * Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.
     * @type {string}
     * @memberof TransactionsAndReportingApiGetActivities
     */

package/dist/api/transactions-and-reporting-api-generated.js

@@ -44,7 +44,7 @@ const TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
          * @param {string | Date} [endDate] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
          * @param {string} [accounts] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
          * @param {string} [brokerageAuthorizations] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-         * @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.
+         * @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */