snaptrade-typescript-sdk 9.0.187 → 9.0.188

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.187-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.187)
+[![npm](https://img.shields.io/badge/npm-v9.0.188-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.188)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -70,6 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.trading.getUserAccountOptionQuotes`](#snaptradetradinggetuseraccountoptionquotes)
   * [`snaptrade.trading.getUserAccountQuotes`](#snaptradetradinggetuseraccountquotes)
   * [`snaptrade.trading.placeBracketOrder`](#snaptradetradingplacebracketorder)
+  * [`snaptrade.trading.placeComplexOrder`](#snaptradetradingplacecomplexorder)
   * [`snaptrade.trading.placeCryptoOrder`](#snaptradetradingplacecryptoorder)
   * [`snaptrade.trading.placeForceOrder`](#snaptradetradingplaceforceorder)
   * [`snaptrade.trading.placeMlegOrder`](#snaptradetradingplacemlegorder)
@@ -2327,6 +2328,78 @@ Number of shares for the order. This can be a decimal for fractional orders. Mus
 ---
 
 
+### `snaptrade.trading.placeComplexOrder`<a id="snaptradetradingplacecomplexorder"></a>
+
+Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable.
+Only supported on certain brokerages.
+
+- **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled.
+- **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order.
+- **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```typescript
+const placeComplexOrderResponse = await snaptrade.trading.placeComplexOrder({
+  accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  userId: "snaptrade-user-123",
+  userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+  type: "OTO",
+  orders: [
+    {
+      order_role: "TRIGGER",
+      action: "BUY",
+      instrument: {
+        symbol: "AAPL",
+        type: "EQUITY",
+      },
+      order_type: "Market",
+      units: 10.5,
+      time_in_force: "Day",
+      price: 31.33,
+      stop: 29.5,
+    },
+  ],
+  client_order_id: "my-order-123",
+});
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### type: `string`<a id="type-string"></a>
+
+The complex order type. - `OCO`: One Cancels the Other — two peer orders. - `OTO`: One Triggers the Other — a trigger order and a conditional order. - `OTOCO`: One Triggers a One Cancels the Other — a trigger order and two peer orders. 
+
+##### orders: [`ComplexOrderLeg`](./models/complex-order-leg.ts)[]<a id="orders-complexorderlegmodelscomplex-order-legts"></a>
+
+The orders that make up the complex order. Required counts and roles per type: - `OCO`: exactly 2 orders, both `PEER` - `OTO`: exactly 2 orders, one `TRIGGER` and one `CONDITIONAL` - `OTOCO`: exactly 3 orders, one `TRIGGER` and two `PEER` 
+
+##### accountId: `string`<a id="accountid-string"></a>
+
+The ID of the account to execute the trade on.
+
+##### userId: `string`<a id="userid-string"></a>
+
+##### userSecret: `string`<a id="usersecret-string"></a>
+
+##### client_order_id: `string`<a id="client_order_id-string"></a>
+
+An optional client-provided identifier for this complex order. Passed through to the brokerage and returned in the response.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[ComplexOrderResponse](./models/complex-order-response.ts)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/complex` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.trading.placeCryptoOrder`<a id="snaptradetradingplacecryptoorder"></a>
 
 Places an order in the specified account.

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

@@ -4,12 +4,14 @@ import { RequestArgs, BaseAPI } from '../base';
 import { AccountInformationGetUserAccountOrderDetailRequest } from '../models';
 import { AccountOrderRecord } from '../models';
 import { CancelOrderResponse } from '../models';
+import { ComplexOrderResponse } from '../models';
 import { CryptoOrderForm } from '../models';
 import { CryptoOrderPreview } from '../models';
 import { CryptocurrencyPairQuote } from '../models';
 import { ManualTradeAndImpact } from '../models';
 import { ManualTradeForm } from '../models';
 import { ManualTradeFormBracket } from '../models';
+import { ManualTradeFormComplex } from '../models';
 import { ManualTradeFormWithOptions } from '../models';
 import { ManualTradeReplaceForm } from '../models';
 import { MlegOrderResponse } from '../models';
@@ -114,6 +116,17 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     placeBracketOrder: (accountId: string, userId: string, userSecret: string, manualTradeFormBracket: ManualTradeFormBracket, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages.  - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
+     * @summary Place complex order
+     * @param {string} accountId The ID of the account to execute the trade on.
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {ManualTradeFormComplex} manualTradeFormComplex
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    placeComplexOrder: (accountId: string, userId: string, userSecret: string, manualTradeFormComplex: ManualTradeFormComplex, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
      * @summary Place crypto order
@@ -262,6 +275,14 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
+    /**
+     * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages.  - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
+     * @summary Place complex order
+     * @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    placeComplexOrder(requestParameters: TradingApiPlaceComplexOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ComplexOrderResponse>>;
     /**
      * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
      * @summary Place crypto order
@@ -389,6 +410,14 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
+    /**
+     * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages.  - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
+     * @summary Place complex order
+     * @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    placeComplexOrder(requestParameters: TradingApiPlaceComplexOrderRequest, options?: AxiosRequestConfig): AxiosPromise<ComplexOrderResponse>;
     /**
      * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
      * @summary Place crypto order
@@ -664,6 +693,31 @@ export type TradingApiPlaceBracketOrderRequest = {
     */
     readonly userSecret: string;
 } & ManualTradeFormBracket;
+/**
+ * Request parameters for placeComplexOrder operation in TradingApi.
+ * @export
+ * @interface TradingApiPlaceComplexOrderRequest
+ */
+export type TradingApiPlaceComplexOrderRequest = {
+    /**
+    * The ID of the account to execute the trade on.
+    * @type {string}
+    * @memberof TradingApiPlaceComplexOrder
+    */
+    readonly accountId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof TradingApiPlaceComplexOrder
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof TradingApiPlaceComplexOrder
+    */
+    readonly userSecret: string;
+} & ManualTradeFormComplex;
 /**
  * Request parameters for placeCryptoOrder operation in TradingApi.
  * @export
@@ -925,6 +979,15 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @memberof TradingApiGenerated
      */
     placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
+    /**
+     * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages.  - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
+     * @summary Place complex order
+     * @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TradingApiGenerated
+     */
+    placeComplexOrder(requestParameters: TradingApiPlaceComplexOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ComplexOrderResponse, any, {}>>;
     /**
      * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
      * @summary Place crypto order

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

@@ -522,6 +522,67 @@ const TradingApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages.  - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
+         * @summary Place complex order
+         * @param {string} accountId The ID of the account to execute the trade on.
+         * @param {string} userId
+         * @param {string} userSecret
+         * @param {ManualTradeFormComplex} manualTradeFormComplex
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        placeComplexOrder: (accountId, userId, userSecret, manualTradeFormComplex, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'accountId' is not null or undefined
+            (0, common_1.assertParamExists)('placeComplexOrder', 'accountId', accountId);
+            // verify required parameter 'userId' is not null or undefined
+            (0, common_1.assertParamExists)('placeComplexOrder', 'userId', userId);
+            // verify required parameter 'userSecret' is not null or undefined
+            (0, common_1.assertParamExists)('placeComplexOrder', 'userSecret', userSecret);
+            // verify required parameter 'manualTradeFormComplex' is not null or undefined
+            (0, common_1.assertParamExists)('placeComplexOrder', 'manualTradeFormComplex', manualTradeFormComplex);
+            const localVarPath = `/accounts/{accountId}/trading/complex`
+                .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
+            const localVarQueryParameter = {};
+            // authentication PartnerClientId required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
+            // authentication PartnerSignature required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
+            // authentication PartnerTimestamp required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
+            if (userId !== undefined) {
+                localVarQueryParameter['userId'] = userId;
+            }
+            if (userSecret !== undefined) {
+                localVarQueryParameter['userSecret'] = userSecret;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            (0, requestBeforeHook_1.requestBeforeHook)({
+                requestBody: manualTradeFormComplex,
+                queryParameters: localVarQueryParameter,
+                requestConfig: localVarRequestOptions,
+                path: localVarPath,
+                configuration,
+                pathTemplate: '/accounts/{accountId}/trading/complex',
+                httpMethod: 'POST'
+            });
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(manualTradeFormComplex, localVarRequestOptions, configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
          * @summary Place crypto order
@@ -1096,6 +1157,24 @@ const TradingApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages.  - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
+         * @summary Place complex order
+         * @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        placeComplexOrder(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const manualTradeFormComplex = {
+                    type: requestParameters.type,
+                    orders: requestParameters.orders,
+                    client_order_id: requestParameters.client_order_id
+                };
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.placeComplexOrder(requestParameters.accountId, requestParameters.userId, requestParameters.userSecret, manualTradeFormComplex, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
          * @summary Place crypto order
@@ -1334,6 +1413,16 @@ const TradingApiFactory = function (configuration, basePath, axios) {
         placeBracketOrder(requestParameters, options) {
             return localVarFp.placeBracketOrder(requestParameters, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages.  - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
+         * @summary Place complex order
+         * @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        placeComplexOrder(requestParameters, options) {
+            return localVarFp.placeComplexOrder(requestParameters, options).then((request) => request(axios, basePath));
+        },
         /**
          * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
          * @summary Place crypto order
@@ -1503,6 +1592,17 @@ class TradingApiGenerated extends base_1.BaseAPI {
     placeBracketOrder(requestParameters, options) {
         return (0, exports.TradingApiFp)(this.configuration).placeBracketOrder(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages.  - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
+     * @summary Place complex order
+     * @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TradingApiGenerated
+     */
+    placeComplexOrder(requestParameters, options) {
+        return (0, exports.TradingApiFp)(this.configuration).placeComplexOrder(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
      * @summary Place crypto order