snaptrade-typescript-sdk 9.0.187 → 9.0.188

package/dist/configuration.js

@@ -32,7 +32,7 @@ class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
-        this.userAgent = param.userAgent === undefined ? "Konfig/9.0.187/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/9.0.188/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/models/complex-order-leg.d.ts

@@ -0,0 +1,62 @@
+import { ActionStrict } from './action-strict';
+import { OrderTypeStrict } from './order-type-strict';
+import { TimeInForceStrict } from './time-in-force-strict';
+import { TradingInstrument } from './trading-instrument';
+/**
+ * A single leg within a complex order.
+ * @export
+ * @interface ComplexOrderLeg
+ */
+export interface ComplexOrderLeg {
+    [key: string]: any;
+    /**
+     * The role of this leg within the complex order.
+     * @type {string}
+     * @memberof ComplexOrderLeg
+     */
+    'order_role': ComplexOrderLegOrderRoleEnum;
+    /**
+     * The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
+     * @type {ActionStrict}
+     * @memberof ComplexOrderLeg
+     */
+    'action': ActionStrict;
+    /**
+     *
+     * @type {TradingInstrument}
+     * @memberof ComplexOrderLeg
+     */
+    'instrument': TradingInstrument;
+    /**
+     * The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required.
+     * @type {OrderTypeStrict}
+     * @memberof ComplexOrderLeg
+     */
+    'order_type': OrderTypeStrict;
+    /**
+     * Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided.
+     * @type {number}
+     * @memberof ComplexOrderLeg
+     */
+    'units': number;
+    /**
+     * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.
+     * @type {TimeInForceStrict}
+     * @memberof ComplexOrderLeg
+     */
+    'time_in_force': TimeInForceStrict;
+    /**
+     * The limit price. Required when `order_type` is `Limit` or `StopLimit`.
+     * @type {number}
+     * @memberof ComplexOrderLeg
+     */
+    'price'?: number | null;
+    /**
+     * The stop trigger price. Required when `order_type` is `Stop` or `StopLimit`.
+     * @type {number}
+     * @memberof ComplexOrderLeg
+     */
+    'stop'?: number | null;
+}
+type ComplexOrderLegOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
+export {};

package/dist/models/complex-order-leg.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/complex-order-response.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Response returned after successfully placing a complex order. AccountOrderRecord rows for the legs are not created synchronously — they\'re hydrated by the next brokerage sync, and can be queried later using the returned `brokerage_group_order_id`.
+ * @export
+ * @interface ComplexOrderResponse
+ */
+export interface ComplexOrderResponse {
+    [key: string]: any;
+    /**
+     * The complex order type that was placed.
+     * @type {string}
+     * @memberof ComplexOrderResponse
+     */
+    'type'?: ComplexOrderResponseTypeEnum;
+    /**
+     * The brokerage-assigned identifier that links all legs of this complex order together. Each leg will eventually appear as a separate AccountOrderRecord sharing this value. May be null if the brokerage does not return a group identifier.
+     * @type {string}
+     * @memberof ComplexOrderResponse
+     */
+    'brokerage_group_order_id'?: string | null;
+}
+type ComplexOrderResponseTypeEnum = 'OCO' | 'OTO' | 'OTOCO';
+export {};

package/dist/models/complex-order-response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/index.d.ts

@@ -42,6 +42,8 @@ export * from './brokerage-instruments-response';
 export * from './brokerage-type';
 export * from './cancel-order-response';
 export * from './child-brokerage-order-ids';
+export * from './complex-order-leg';
+export * from './complex-order-response';
 export * from './connections-session-events200-response-inner';
 export * from './crypto-order-form';
 export * from './crypto-order-preview';
@@ -65,6 +67,7 @@ export * from './manual-trade-and-impact';
 export * from './manual-trade-balance';
 export * from './manual-trade-form';
 export * from './manual-trade-form-bracket';
+export * from './manual-trade-form-complex';
 export * from './manual-trade-form-notional-value';
 export * from './manual-trade-form-with-options';
 export * from './manual-trade-impact';

package/dist/models/index.js

@@ -58,6 +58,8 @@ __exportStar(require("./brokerage-instruments-response"), exports);
 __exportStar(require("./brokerage-type"), exports);
 __exportStar(require("./cancel-order-response"), exports);
 __exportStar(require("./child-brokerage-order-ids"), exports);
+__exportStar(require("./complex-order-leg"), exports);
+__exportStar(require("./complex-order-response"), exports);
 __exportStar(require("./connections-session-events200-response-inner"), exports);
 __exportStar(require("./crypto-order-form"), exports);
 __exportStar(require("./crypto-order-preview"), exports);
@@ -81,6 +83,7 @@ __exportStar(require("./manual-trade-and-impact"), exports);
 __exportStar(require("./manual-trade-balance"), exports);
 __exportStar(require("./manual-trade-form"), exports);
 __exportStar(require("./manual-trade-form-bracket"), exports);
+__exportStar(require("./manual-trade-form-complex"), exports);
 __exportStar(require("./manual-trade-form-notional-value"), exports);
 __exportStar(require("./manual-trade-form-with-options"), exports);
 __exportStar(require("./manual-trade-impact"), exports);

package/dist/models/manual-trade-form-complex.d.ts

@@ -0,0 +1,28 @@
+import { ComplexOrderLeg } from './complex-order-leg';
+/**
+ * Request body for placing a complex conditional order (OCO, OTO, or OTOCO).
+ * @export
+ * @interface ManualTradeFormComplex
+ */
+export interface ManualTradeFormComplex {
+    /**
+     * 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.
+     * @type {string}
+     * @memberof ManualTradeFormComplex
+     */
+    'type': ManualTradeFormComplexTypeEnum;
+    /**
+     * 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`
+     * @type {Array<ComplexOrderLeg>}
+     * @memberof ManualTradeFormComplex
+     */
+    'orders': Array<ComplexOrderLeg>;
+    /**
+     * An optional client-provided identifier for this complex order. Passed through to the brokerage and returned in the response.
+     * @type {string}
+     * @memberof ManualTradeFormComplex
+     */
+    'client_order_id'?: string | null;
+}
+type ManualTradeFormComplexTypeEnum = 'OCO' | 'OTO' | 'OTOCO';
+export {};

package/dist/models/manual-trade-form-complex.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/operationParameterMap.js

@@ -703,6 +703,28 @@ exports.operationParameterMap = {
             },
         ]
     },
+    '/accounts/{accountId}/trading/complex-POST': {
+        parameters: [
+            {
+                name: 'type'
+            },
+            {
+                name: 'orders'
+            },
+            {
+                name: 'accountId'
+            },
+            {
+                name: 'userId'
+            },
+            {
+                name: 'userSecret'
+            },
+            {
+                name: 'client_order_id'
+            },
+        ]
+    },
     '/accounts/{accountId}/trading/crypto-POST': {
         parameters: [
             {

package/package.json

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