snaptrade-typescript-sdk 9.0.174 → 9.0.176

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.174/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/9.0.176/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/models/index.d.ts

@@ -96,6 +96,7 @@ export * from './option-chain-inner-chain-per-root-inner-chain-per-strike-price-
 export * from './option-impact';
 export * from './option-leg';
 export * from './option-quote';
+export * from './option-quote-greeks';
 export * from './option-strategy';
 export * from './option-strategy-legs-inner';
 export * from './options-position';
@@ -103,6 +104,7 @@ export * from './options-position-currency';
 export * from './options-symbol';
 export * from './order-type-strict';
 export * from './order-updated-response';
+export * from './order-updated-response-order';
 export * from './paginated-universal-activity';
 export * from './pagination-details';
 export * from './partner-data';

package/dist/models/index.js

@@ -112,6 +112,7 @@ __exportStar(require("./option-chain-inner-chain-per-root-inner-chain-per-strike
 __exportStar(require("./option-impact"), exports);
 __exportStar(require("./option-leg"), exports);
 __exportStar(require("./option-quote"), exports);
+__exportStar(require("./option-quote-greeks"), exports);
 __exportStar(require("./option-strategy"), exports);
 __exportStar(require("./option-strategy-legs-inner"), exports);
 __exportStar(require("./options-position"), exports);
@@ -119,6 +120,7 @@ __exportStar(require("./options-position-currency"), exports);
 __exportStar(require("./options-symbol"), exports);
 __exportStar(require("./order-type-strict"), exports);
 __exportStar(require("./order-updated-response"), exports);
+__exportStar(require("./order-updated-response-order"), exports);
 __exportStar(require("./paginated-universal-activity"), exports);
 __exportStar(require("./pagination-details"), exports);
 __exportStar(require("./partner-data"), exports);

package/dist/models/option-quote-greeks.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The Greeks for the option contract.
+ * @export
+ * @interface OptionQuoteGreeks
+ */
+export interface OptionQuoteGreeks {
+    [key: string]: any;
+    /**
+     * Delta represents the rate of change between the option\'s price and a $1 change in the underlying asset\'s price.
+     * @type {number}
+     * @memberof OptionQuoteGreeks
+     */
+    'delta'?: number;
+    /**
+     * Gamma represents the rate of change between an option\'s delta and the underlying asset\'s price.
+     * @type {number}
+     * @memberof OptionQuoteGreeks
+     */
+    'gamma'?: number;
+    /**
+     * Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option\'s time decay.
+     * @type {number}
+     * @memberof OptionQuoteGreeks
+     */
+    'theta'?: number;
+    /**
+     * Vega represents the rate of change between an option\'s value and the underlying asset\'s implied volatility.
+     * @type {number}
+     * @memberof OptionQuoteGreeks
+     */
+    'vega'?: number;
+}

package/dist/models/option-quote-greeks.js

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

package/dist/models/option-quote.d.ts

@@ -1,3 +1,4 @@
+import { OptionQuoteGreeks } from './option-quote-greeks';
 /**
  * Real-time quote for a single option contract.
  * @export
@@ -12,53 +13,11 @@ export interface OptionQuote {
      */
     'symbol'?: string;
     /**
-     * The best bid price for the option contract.
+     * The derived synthetic price of the contract.
      * @type {number}
      * @memberof OptionQuote
      */
-    'bid_price'?: number;
-    /**
-     * The number of contracts available at the bid price.
-     * @type {number}
-     * @memberof OptionQuote
-     */
-    'bid_size'?: number;
-    /**
-     * The best ask price for the option contract.
-     * @type {number}
-     * @memberof OptionQuote
-     */
-    'ask_price'?: number;
-    /**
-     * The number of contracts available at the ask price.
-     * @type {number}
-     * @memberof OptionQuote
-     */
-    'ask_size'?: number;
-    /**
-     * The price of the last trade for the option contract.
-     * @type {number}
-     * @memberof OptionQuote
-     */
-    'last_price'?: number;
-    /**
-     * The number of contracts in the last trade.
-     * @type {number}
-     * @memberof OptionQuote
-     */
-    'last_size'?: number;
-    /**
-     * The total number of outstanding contracts.
-     * @type {number}
-     * @memberof OptionQuote
-     */
-    'open_interest'?: number;
-    /**
-     * The total number of contracts traded during the current session.
-     * @type {number}
-     * @memberof OptionQuote
-     */
-    'volume'?: number;
+    'synthetic_price'?: number;
     /**
      * The implied volatility of the option contract.
      * @type {number}
@@ -66,15 +25,15 @@ export interface OptionQuote {
      */
     'implied_volatility'?: number;
     /**
-     * The current price of the underlying security.
-     * @type {number}
+     * The timestamp of the last update for the option quote.
+     * @type {string}
      * @memberof OptionQuote
      */
-    'underlying_price'?: number;
+    'timestamp'?: string | null;
     /**
-     * The timestamp of the quote.
-     * @type {string}
+     *
+     * @type {OptionQuoteGreeks}
      * @memberof OptionQuote
      */
-    'timestamp'?: string | null;
+    'greeks'?: OptionQuoteGreeks;
 }

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

@@ -0,0 +1,146 @@
+import { AccountOrderRecordChildBrokerageOrderIds } from './account-order-record-child-brokerage-order-ids';
+import { AccountOrderRecordOptionSymbol } from './account-order-record-option-symbol';
+import { AccountOrderRecordQuoteCurrency } from './account-order-record-quote-currency';
+import { AccountOrderRecordQuoteUniversalSymbol } from './account-order-record-quote-universal-symbol';
+import { AccountOrderRecordStatus } from './account-order-record-status';
+import { AccountOrderRecordUniversalSymbol } from './account-order-record-universal-symbol';
+/**
+ *
+ * @export
+ * @interface OrderUpdatedResponseOrder
+ */
+export interface OrderUpdatedResponseOrder {
+    /**
+     * Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'brokerage_order_id'?: string;
+    /**
+     * Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include:   - NONE   - PENDING   - ACCEPTED   - FAILED   - REJECTED   - CANCELED   - PARTIAL_CANCELED   - CANCEL_PENDING   - EXECUTED   - PARTIAL   - REPLACE_PENDING   - REPLACED   - EXPIRED   - QUEUED   - TRIGGERED   - ACTIVATED
+     * @type {AccountOrderRecordStatus}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'status'?: AccountOrderRecordStatus;
+    /**
+     *
+     * @type {AccountOrderRecordUniversalSymbol}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'universal_symbol'?: AccountOrderRecordUniversalSymbol;
+    /**
+     *
+     * @type {AccountOrderRecordOptionSymbol}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'option_symbol'?: AccountOrderRecordOptionSymbol;
+    /**
+     *
+     * @type {AccountOrderRecordQuoteUniversalSymbol}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'quote_universal_symbol'?: AccountOrderRecordQuoteUniversalSymbol;
+    /**
+     *
+     * @type {AccountOrderRecordQuoteCurrency}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'quote_currency'?: AccountOrderRecordQuoteCurrency;
+    /**
+     * The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage.   - BUY   - SELL   - BUY_COVER   - SELL_SHORT   - BUY_OPEN   - BUY_CLOSE   - SELL_OPEN   - SELL_CLOSE
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'action'?: string;
+    /**
+     * The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'total_quantity'?: string | null;
+    /**
+     * The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'open_quantity'?: string | null;
+    /**
+     * The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'canceled_quantity'?: string | null;
+    /**
+     * The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'filled_quantity'?: string | null;
+    /**
+     * The price at which the order was executed.
+     * @type {number}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'execution_price'?: number | null;
+    /**
+     * The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders.
+     * @type {number}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'limit_price'?: number | null;
+    /**
+     * The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders.
+     * @type {number}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'stop_price'?: number | null;
+    /**
+     * The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage\'s order type value.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'order_type'?: string | null;
+    /**
+     * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage\'s time in force value.   - `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.   - `GTD` - Good Til Date. The order is valid until the specified date.   - `MOO` - Market On Open. The order is to be executed at the day\'s opening price.   - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'time_in_force'?: string;
+    /**
+     * The time the order was placed. This is the time the order was submitted to the brokerage.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'time_placed'?: string;
+    /**
+     * The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'time_updated'?: string | null;
+    /**
+     * The time the order was executed in the brokerage system. This value is not always available from the brokerage.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'time_executed'?: string | null;
+    /**
+     * The time the order expires. This value is not always available from the brokerage.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'expiry_date'?: string | null;
+    /**
+     * A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
+     * @type {string}
+     * @memberof OrderUpdatedResponseOrder
+     * @deprecated
+     */
+    'symbol'?: string;
+    /**
+     *
+     * @type {AccountOrderRecordChildBrokerageOrderIds}
+     * @memberof OrderUpdatedResponseOrder
+     */
+    'child_brokerage_order_ids'?: AccountOrderRecordChildBrokerageOrderIds | null;
+}

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

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

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

@@ -1,4 +1,4 @@
-import { AccountOrderRecord } from './account-order-record';
+import { OrderUpdatedResponseOrder } from './order-updated-response-order';
 /**
  *
  * @export
@@ -14,8 +14,8 @@ export interface OrderUpdatedResponse {
     'brokerage_order_id': string;
     /**
      *
-     * @type {AccountOrderRecord}
+     * @type {OrderUpdatedResponseOrder}
      * @memberof OrderUpdatedResponse
      */
-    'order'?: AccountOrderRecord;
+    'order'?: OrderUpdatedResponseOrder | null;
 }

package/dist/models/position.d.ts

@@ -15,7 +15,7 @@ export interface Position {
      */
     'symbol'?: PositionSymbol;
     /**
-     * The number of shares of the position. This can be fractional or integer units.
+     * The number of shares of the position. This can be fractional or integer units. A positive number indicates a long position, while a negative number indicates a short position.
      * @type {number}
      * @memberof Position
      */

package/package.json

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