snaptrade-typescript-sdk 9.0.199 → 10.0.1

package/dist/models/account-order-record-v2.d.ts

@@ -1,97 +0,0 @@
-import { AccountOrderRecordLeg } from './account-order-record-leg';
-import { AccountOrderRecordStatus } from './account-order-record-status';
-import { AccountOrderRecordTrailingStop } from './account-order-record-trailing-stop';
-/**
- * Describes a single order in the standardized V2 format.
- * @export
- * @interface AccountOrderRecordV2
- */
-export interface AccountOrderRecordV2 {
-    [key: string]: any;
-    /**
-     * Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
-     * @type {string}
-     * @memberof AccountOrderRecordV2
-     */
-    'brokerage_order_id'?: string;
-    /**
-     * The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier.
-     * @type {string}
-     * @memberof AccountOrderRecordV2
-     */
-    'brokerage_group_order_id'?: string | null;
-    /**
-     * The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders.
-     * @type {string}
-     * @memberof AccountOrderRecordV2
-     */
-    'order_role'?: AccountOrderRecordV2OrderRoleEnum;
-    /**
-     * 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 AccountOrderRecordV2
-     */
-    'status'?: AccountOrderRecordStatus;
-    /**
-     * The type of order placed.   - `MARKET`   - `LIMIT`   - `STOP`   - `STOP_LIMIT`
-     * @type {string}
-     * @memberof AccountOrderRecordV2
-     */
-    '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 AccountOrderRecordV2
-     */
-    'time_in_force'?: string;
-    /**
-     * The time the order was placed. This is the time the order was submitted to the brokerage.
-     * @type {string}
-     * @memberof AccountOrderRecordV2
-     */
-    'time_placed'?: string;
-    /**
-     * The time the order was executed in the brokerage system. This value is not always available from the brokerage.
-     * @type {string}
-     * @memberof AccountOrderRecordV2
-     */
-    'time_executed'?: string | null;
-    /**
-     * Quote currency code for the order.
-     * @type {string}
-     * @memberof AccountOrderRecordV2
-     */
-    'quote_currency'?: string;
-    /**
-     * The price at which the order was executed.
-     * @type {number}
-     * @memberof AccountOrderRecordV2
-     */
-    '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 AccountOrderRecordV2
-     */
-    '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 AccountOrderRecordV2
-     */
-    'stop_price'?: number | null;
-    /**
-     *
-     * @type {AccountOrderRecordTrailingStop}
-     * @memberof AccountOrderRecordV2
-     */
-    'trailing_stop'?: AccountOrderRecordTrailingStop | null;
-    /**
-     * List of legs that make up the order.
-     * @type {Array<AccountOrderRecordLeg>}
-     * @memberof AccountOrderRecordV2
-     */
-    'legs'?: Array<AccountOrderRecordLeg>;
-}
-type AccountOrderRecordV2OrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
-export {};

package/dist/models/account-order-record-v2.js

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

package/dist/models/account-order-record.d.ts

@@ -1,168 +0,0 @@
-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 { AccountOrderRecordTrailingStop } from './account-order-record-trailing-stop';
-import { AccountOrderRecordUniversalSymbol } from './account-order-record-universal-symbol';
-/**
- * Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records.
- * @export
- * @interface AccountOrderRecord
- */
-export interface AccountOrderRecord {
-    [key: string]: any;
-    /**
-     * Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
-     * @type {string}
-     * @memberof AccountOrderRecord
-     */
-    'brokerage_order_id'?: string;
-    /**
-     * The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier.
-     * @type {string}
-     * @memberof AccountOrderRecord
-     */
-    'brokerage_group_order_id'?: string | null;
-    /**
-     * The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders.
-     * @type {string}
-     * @memberof AccountOrderRecord
-     */
-    'order_role'?: AccountOrderRecordOrderRoleEnum;
-    /**
-     * 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 AccountOrderRecord
-     */
-    'status'?: AccountOrderRecordStatus;
-    /**
-     *
-     * @type {AccountOrderRecordUniversalSymbol}
-     * @memberof AccountOrderRecord
-     */
-    'universal_symbol'?: AccountOrderRecordUniversalSymbol;
-    /**
-     *
-     * @type {AccountOrderRecordOptionSymbol}
-     * @memberof AccountOrderRecord
-     */
-    'option_symbol'?: AccountOrderRecordOptionSymbol;
-    /**
-     *
-     * @type {AccountOrderRecordQuoteUniversalSymbol}
-     * @memberof AccountOrderRecord
-     */
-    'quote_universal_symbol'?: AccountOrderRecordQuoteUniversalSymbol;
-    /**
-     *
-     * @type {AccountOrderRecordQuoteCurrency}
-     * @memberof AccountOrderRecord
-     */
-    '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 AccountOrderRecord
-     */
-    '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 AccountOrderRecord
-     */
-    '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 AccountOrderRecord
-     */
-    '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 AccountOrderRecord
-     */
-    '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 AccountOrderRecord
-     */
-    'filled_quantity'?: string | null;
-    /**
-     * The price at which the order was executed. For option orders, this represents the price per share.
-     * @type {number}
-     * @memberof AccountOrderRecord
-     */
-    '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. For option orders, this represents the price per share.
-     * @type {number}
-     * @memberof AccountOrderRecord
-     */
-    '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. For option orders, this represents the price per share.
-     * @type {number}
-     * @memberof AccountOrderRecord
-     */
-    'stop_price'?: number | null;
-    /**
-     *
-     * @type {AccountOrderRecordTrailingStop}
-     * @memberof AccountOrderRecord
-     */
-    'trailing_stop'?: AccountOrderRecordTrailingStop | 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 AccountOrderRecord
-     */
-    '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 AccountOrderRecord
-     */
-    'time_in_force'?: string;
-    /**
-     * The time the order was placed. This is the time the order was submitted to the brokerage.
-     * @type {string}
-     * @memberof AccountOrderRecord
-     */
-    '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 AccountOrderRecord
-     */
-    '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 AccountOrderRecord
-     */
-    'time_executed'?: string | null;
-    /**
-     * The time the order expires. This value is not always available from the brokerage.
-     * @type {string}
-     * @memberof AccountOrderRecord
-     */
-    '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 AccountOrderRecord
-     * @deprecated
-     */
-    'symbol'?: string;
-    /**
-     *
-     * @type {AccountOrderRecordChildBrokerageOrderIds}
-     * @memberof AccountOrderRecord
-     */
-    'child_brokerage_order_ids'?: AccountOrderRecordChildBrokerageOrderIds | null;
-}
-type AccountOrderRecordOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
-export {};

package/dist/models/account-order-record.js

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

package/dist/models/account-orders-v2-response.d.ts

@@ -1,15 +0,0 @@
-import { AccountOrderRecordV2 } from './account-order-record-v2';
-/**
- * Contains a standardized list of account orders in the V2 format.
- * @export
- * @interface AccountOrdersV2Response
- */
-export interface AccountOrdersV2Response {
-    [key: string]: any;
-    /**
-     * List of orders returned by the endpoint.
-     * @type {Array<AccountOrderRecordV2>}
-     * @memberof AccountOrdersV2Response
-     */
-    'orders': Array<AccountOrderRecordV2>;
-}

package/dist/models/account-orders-v2-response.js

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

package/dist/models/account-position.d.ts

@@ -1,52 +0,0 @@
-import { Instrument } from './instrument';
-import { TaxLot } from './tax-lot';
-/**
- * Describes a single position.
- * @export
- * @interface AccountPosition
- */
-export interface AccountPosition {
-    [key: string]: any;
-    /**
-     *
-     * @type {Instrument}
-     * @memberof AccountPosition
-     */
-    'instrument': Instrument;
-    /**
-     * The number of units held in the position. Positive numbers indicate long positions and negative numbers indicate short positions.
-     * @type {string}
-     * @memberof AccountPosition
-     */
-    'units'?: string | null;
-    /**
-     * Last known market price for the position.
-     * @type {string}
-     * @memberof AccountPosition
-     */
-    'price'?: string | null;
-    /**
-     * Book price or average purchase price for the position.
-     * @type {string}
-     * @memberof AccountPosition
-     */
-    'cost_basis'?: string | null;
-    /**
-     * ISO-4217 currency code for the position `price` and `cost_basis`.
-     * @type {string}
-     * @memberof AccountPosition
-     */
-    'currency'?: string | null;
-    /**
-     * Present for mutual fund positions that are also counted in cash balance or buying power.
-     * @type {boolean}
-     * @memberof AccountPosition
-     */
-    'cash_equivalent'?: boolean;
-    /**
-     * Present for stock positions when tax lot data is enabled for the account.
-     * @type {Array<TaxLot>}
-     * @memberof AccountPosition
-     */
-    'tax_lots'?: Array<TaxLot>;
-}

package/dist/models/account-position.js

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

package/dist/models/account-simple.d.ts

@@ -1,39 +0,0 @@
-import { AccountSyncStatus } from './account-sync-status';
-/**
- * A single account at a brokerage.
- * @export
- * @interface AccountSimple
- */
-export interface AccountSimple {
-    [key: string]: any;
-    /**
-     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
-     * @type {string}
-     * @memberof AccountSimple
-     */
-    'id'?: string;
-    /**
-     * A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
-     * @type {string}
-     * @memberof AccountSimple
-     */
-    'name'?: string;
-    /**
-     * The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
-     * @type {string}
-     * @memberof AccountSimple
-     */
-    'number'?: string;
-    /**
-     * A stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.
-     * @type {string}
-     * @memberof AccountSimple
-     */
-    'institution_account_id'?: string | null;
-    /**
-     *
-     * @type {AccountSyncStatus}
-     * @memberof AccountSimple
-     */
-    'sync_status'?: AccountSyncStatus;
-}

package/dist/models/account-simple.js

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

package/dist/models/account-sync-status.d.ts

@@ -1,21 +0,0 @@
-import { HoldingsStatus } from './holdings-status';
-import { TransactionsStatus } from './transactions-status';
-/**
- * Contains status update for the account sync process between SnapTrade and the brokerage.
- * @export
- * @interface AccountSyncStatus
- */
-export interface AccountSyncStatus {
-    /**
-     *
-     * @type {TransactionsStatus}
-     * @memberof AccountSyncStatus
-     */
-    'transactions'?: TransactionsStatus;
-    /**
-     *
-     * @type {HoldingsStatus}
-     * @memberof AccountSyncStatus
-     */
-    'holdings'?: HoldingsStatus;
-}

package/dist/models/account-sync-status.js

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

package/dist/models/account-universal-activity-currency.d.ts

@@ -1,25 +0,0 @@
-/**
- * The currency in which the transaction `price` and `amount` is denominated.
- * @export
- * @interface AccountUniversalActivityCurrency
- */
-export interface AccountUniversalActivityCurrency {
-    /**
-     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
-     * @type {string}
-     * @memberof AccountUniversalActivityCurrency
-     */
-    'id'?: string;
-    /**
-     * The ISO-4217 currency code for the currency.
-     * @type {string}
-     * @memberof AccountUniversalActivityCurrency
-     */
-    'code'?: string;
-    /**
-     * A human-friendly name of the currency.
-     * @type {string}
-     * @memberof AccountUniversalActivityCurrency
-     */
-    'name'?: string;
-}

package/dist/models/account-universal-activity-currency.js

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

package/dist/models/account-universal-activity-option-symbol.d.ts

@@ -1,52 +0,0 @@
-import { UnderlyingSymbol } from './underlying-symbol';
-/**
- * The option security for the transaction. The field is `null` if the transaction is not related to an option security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage\'s option symbol. In cases where the brokerage option symbol is not recognized, the field will be set to `null`.
- * @export
- * @interface AccountUniversalActivityOptionSymbol
- */
-export interface AccountUniversalActivityOptionSymbol {
-    /**
-     * Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
-     * @type {string}
-     * @memberof AccountUniversalActivityOptionSymbol
-     */
-    'id': string;
-    /**
-     * The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
-     * @type {string}
-     * @memberof AccountUniversalActivityOptionSymbol
-     */
-    'ticker': string;
-    /**
-     * The type of option. Either \"CALL\" or \"PUT\".
-     * @type {string}
-     * @memberof AccountUniversalActivityOptionSymbol
-     */
-    'option_type': AccountUniversalActivityOptionSymbolOptionTypeEnum;
-    /**
-     * The option strike price.
-     * @type {number}
-     * @memberof AccountUniversalActivityOptionSymbol
-     */
-    'strike_price': number;
-    /**
-     * The option expiration date.
-     * @type {string}
-     * @memberof AccountUniversalActivityOptionSymbol
-     */
-    'expiration_date': string;
-    /**
-     * Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
-     * @type {boolean}
-     * @memberof AccountUniversalActivityOptionSymbol
-     */
-    'is_mini_option'?: boolean;
-    /**
-     *
-     * @type {UnderlyingSymbol}
-     * @memberof AccountUniversalActivityOptionSymbol
-     */
-    'underlying_symbol': UnderlyingSymbol;
-}
-type AccountUniversalActivityOptionSymbolOptionTypeEnum = 'CALL' | 'PUT';
-export {};

package/dist/models/account-universal-activity-option-symbol.js

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

package/dist/models/account-universal-activity-symbol.d.ts

@@ -1,65 +0,0 @@
-import { SecurityType } from './security-type';
-import { StockInstrumentFigiInstrument } from './stock-instrument-figi-instrument';
-import { SymbolCurrency } from './symbol-currency';
-import { SymbolExchange } from './symbol-exchange';
-/**
- * The security for the transaction. The field is `null` if the transaction is not related to a security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage\'s symbol. In cases where the brokerage symbol is not recognized, the field will be set to `null`.
- * @export
- * @interface AccountUniversalActivitySymbol
- */
-export interface AccountUniversalActivitySymbol {
-    /**
-     * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
-     * @type {string}
-     * @memberof AccountUniversalActivitySymbol
-     */
-    'id'?: string;
-    /**
-     * The security\'s trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
-     * @type {string}
-     * @memberof AccountUniversalActivitySymbol
-     */
-    'symbol'?: string;
-    /**
-     * The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
-     * @type {string}
-     * @memberof AccountUniversalActivitySymbol
-     */
-    'raw_symbol'?: string;
-    /**
-     * A human-readable description of the security. This is usually the company name or ETF name.
-     * @type {string}
-     * @memberof AccountUniversalActivitySymbol
-     */
-    'description'?: string | null;
-    /**
-     *
-     * @type {SymbolCurrency}
-     * @memberof AccountUniversalActivitySymbol
-     */
-    'currency'?: SymbolCurrency;
-    /**
-     *
-     * @type {SymbolExchange}
-     * @memberof AccountUniversalActivitySymbol
-     */
-    'exchange'?: SymbolExchange;
-    /**
-     *
-     * @type {SecurityType}
-     * @memberof AccountUniversalActivitySymbol
-     */
-    'type'?: SecurityType;
-    /**
-     * This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. This value should be the same as the `figi_code` in the `figi_instrument` child property.
-     * @type {string}
-     * @memberof AccountUniversalActivitySymbol
-     */
-    'figi_code'?: string | null;
-    /**
-     *
-     * @type {StockInstrumentFigiInstrument}
-     * @memberof AccountUniversalActivitySymbol
-     */
-    'figi_instrument'?: StockInstrumentFigiInstrument | null;
-}

package/dist/models/account-universal-activity-symbol.js

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