snaptrade-typescript-sdk 9.0.200 → 10.0.1

package/dist/models/take-profit.d.ts

@@ -1,14 +0,0 @@
-/**
- * Takes in a string value for limit_price
- * @export
- * @interface TakeProfit
- */
-export interface TakeProfit {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof TakeProfit
-     */
-    'limit_price'?: string;
-}

package/dist/models/take-profit.js

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

package/dist/models/tax-lot.d.ts

@@ -1,50 +0,0 @@
-/**
- * Describes a single tax lot for a position.
- * @export
- * @interface TaxLot
- */
-export interface TaxLot {
-    [key: string]: any;
-    /**
-     * The date and time of the purchase.
-     * @type {string}
-     * @memberof TaxLot
-     */
-    'original_purchase_date'?: string | null;
-    /**
-     * The number of shares in the tax lot. This can be fractional or integer units.
-     * @type {string}
-     * @memberof TaxLot
-     */
-    'quantity'?: string | null;
-    /**
-     * The purchase price per share for the tax lot.
-     * @type {string}
-     * @memberof TaxLot
-     */
-    'purchased_price'?: string | null;
-    /**
-     * The cost basis of the entire lot.
-     * @type {string}
-     * @memberof TaxLot
-     */
-    'cost_basis'?: string | null;
-    /**
-     * The current market value of the entire lot.
-     * @type {string}
-     * @memberof TaxLot
-     */
-    'current_value'?: string | null;
-    /**
-     * The type of position for the tax lot (e.g., LONG, SHORT).
-     * @type {string}
-     * @memberof TaxLot
-     */
-    'position_type'?: string | null;
-    /**
-     * The unique id for this specific tax lot
-     * @type {string}
-     * @memberof TaxLot
-     */
-    'lot_id'?: string | null;
-}

package/dist/models/tax-lot.js

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

package/dist/models/time-in-force-strict.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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.
- * @export
- * @enum {string}
- */
-export type TimeInForceStrict = 'FOK' | 'Day' | 'GTC' | 'IOC';

package/dist/models/time-in-force-strict.js

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

package/dist/models/trade-detection-cancel-subscription-response.d.ts

@@ -1,14 +0,0 @@
-/**
- *
- * @export
- * @interface TradeDetectionCancelSubscriptionResponse
- */
-export interface TradeDetectionCancelSubscriptionResponse {
-    [key: string]: any;
-    /**
-     *
-     * @type {boolean}
-     * @memberof TradeDetectionCancelSubscriptionResponse
-     */
-    'success': boolean;
-}

package/dist/models/trade-detection-cancel-subscription-response.js

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

package/dist/models/trade-detection-subscription.d.ts

@@ -1,26 +0,0 @@
-/**
- * An active Trade Detection subscription for a brokerage account.
- * @export
- * @interface TradeDetectionSubscription
- */
-export interface TradeDetectionSubscription {
-    [key: string]: any;
-    /**
-     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
-     * @type {string}
-     * @memberof TradeDetectionSubscription
-     */
-    'account_id': string;
-    /**
-     * Monthly subscription cost as a decimal string.
-     * @type {string}
-     * @memberof TradeDetectionSubscription
-     */
-    'cost': string;
-    /**
-     * How often the subscribed account is checked for new trades.
-     * @type {number}
-     * @memberof TradeDetectionSubscription
-     */
-    'check_interval_seconds': number;
-}

package/dist/models/trade-detection-subscription.js

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

package/dist/models/trading-instrument.d.ts

@@ -1,22 +0,0 @@
-/**
- *
- * @export
- * @interface TradingInstrument
- */
-export interface TradingInstrument {
-    [key: string]: any;
-    /**
-     * The instrument\'s trading ticker symbol. This currently supports stock symbols and Options symbols in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
-     * @type {string}
-     * @memberof TradingInstrument
-     */
-    'symbol': string;
-    /**
-     * The instrument\'s type
-     * @type {string}
-     * @memberof TradingInstrument
-     */
-    'type': TradingInstrumentTypeEnum;
-}
-type TradingInstrumentTypeEnum = 'EQUITY' | 'OPTION' | 'CRYPTOCURRENCY' | 'CRYPTOCURRENCY_PAIR';
-export {};

package/dist/models/trading-instrument.js

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

package/dist/models/trading-search-cryptocurrency-pair-instruments200-response.d.ts

@@ -1,15 +0,0 @@
-import { CryptocurrencyPair } from './cryptocurrency-pair';
-/**
- * The instruments
- * @export
- * @interface TradingSearchCryptocurrencyPairInstruments200Response
- */
-export interface TradingSearchCryptocurrencyPairInstruments200Response {
-    [key: string]: any;
-    /**
-     *
-     * @type {Array<CryptocurrencyPair>}
-     * @memberof TradingSearchCryptocurrencyPairInstruments200Response
-     */
-    'items': Array<CryptocurrencyPair>;
-}

package/dist/models/trading-search-cryptocurrency-pair-instruments200-response.js

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

package/dist/models/trading-session.d.ts

@@ -1,6 +0,0 @@
-/**
- * The trading session for the order. This field indicates which market session the order will be placed in. This is only available for certain brokerages. Defaults to REGULAR. Here are the supported values:   - `REGULAR` - Regular trading hours.   - `EXTENDED` - Extended trading hours.
- * @export
- * @enum {string}
- */
-export type TradingSession = 'REGULAR' | 'EXTENDED';

package/dist/models/trading-session.js

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

package/dist/models/trailing-stop.d.ts

@@ -1,22 +0,0 @@
-/**
- * Trail configuration for trailing stop orders.
- * @export
- * @interface TrailingStop
- */
-export interface TrailingStop {
-    [key: string]: any;
-    /**
-     * The trail amount. Interpreted as dollars if `type` is `DOLLAR`, or a percentage if `type` is `PERCENT`.
-     * @type {string}
-     * @memberof TrailingStop
-     */
-    'amount': string;
-    /**
-     * Whether the trail `amount` is a dollar amount (`DOLLAR`) or a percentage (`PERCENT`). For example, if `amount` is \"0.60\" and `type` is `DOLLAR`, the stop price will trail the market price by $0.60. If `amount` is \"5\" and `type` is `PERCENT`, the stop price will trail the market price by 5%.
-     * @type {string}
-     * @memberof TrailingStop
-     */
-    'type': TrailingStopTypeEnum;
-}
-type TrailingStopTypeEnum = 'DOLLAR' | 'PERCENT';
-export {};

package/dist/models/trailing-stop.js

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

package/dist/models/transactions-status.d.ts

@@ -1,25 +0,0 @@
-/**
- * Status of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check [our integrations doc](https://support.snaptrade.com/brokerages-table?v=6fab8012ade6441fa0c6d9af9c55ce3a) for details on how far back we sync for each brokerage. 2. Daily sync - Once a day SnapTrade syncs new transactions from the brokerage. 3. Manual sync - You can trigger an incremental sync of transactions with the [transactions sync](/reference/Experimental%20endpoints/Connections_syncBrokerageAuthorizationTransactions) endpoint.
- * @export
- * @interface TransactionsStatus
- */
-export interface TransactionsStatus {
-    /**
-     * Indicates if the initial sync of transactions has been completed. For accounts with a large number of transactions, the initial sync may take a while to complete.
-     * @type {boolean}
-     * @memberof TransactionsStatus
-     */
-    'initial_sync_completed'?: boolean;
-    /**
-     * All transactions up to this date have been successfully synced. Please note that this is not the date of the last transaction, nor the last time SnapTrade attempted to sync transactions.
-     * @type {string}
-     * @memberof TransactionsStatus
-     */
-    'last_successful_sync'?: string | null;
-    /**
-     * The date of the first transaction in the account known to SnapTrade. It\'s possible that the account has transactions before this date, but they are not known to SnapTrade.
-     * @type {string}
-     * @memberof TransactionsStatus
-     */
-    'first_transaction_date'?: string | null;
-}

package/dist/models/transactions-status.js

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

package/dist/models/underlying-option-instrument.d.ts

@@ -1,27 +0,0 @@
-import { AdrInstrument } from './adr-instrument';
-import { CefInstrument } from './cef-instrument';
-import { CryptoInstrument } from './crypto-instrument';
-import { EtfInstrument } from './etf-instrument';
-import { MutualFundInstrument } from './mutual-fund-instrument';
-import { OtherInstrument } from './other-instrument';
-import { StockInstrument } from './stock-instrument';
-/**
- * @type UnderlyingOptionInstrument
- * The underlying instrument for an option.
- * @export
- */
-export type UnderlyingOptionInstrument = {
-    kind: 'adr';
-} & AdrInstrument | {
-    kind: 'cef';
-} & CefInstrument | {
-    kind: 'crypto';
-} & CryptoInstrument | {
-    kind: 'etf';
-} & EtfInstrument | {
-    kind: 'mutualfund';
-} & MutualFundInstrument | {
-    kind: 'other';
-} & OtherInstrument | {
-    kind: 'stock';
-} & StockInstrument;

package/dist/models/underlying-option-instrument.js

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

package/dist/models/underlying-symbol-exchange.d.ts

@@ -1,61 +0,0 @@
-/**
- * The exchange on which the security is listed and traded.
- * @export
- * @interface UnderlyingSymbolExchange
- */
-export interface UnderlyingSymbolExchange {
-    /**
-     *
-     * @type {string}
-     * @memberof UnderlyingSymbolExchange
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UnderlyingSymbolExchange
-     */
-    'code'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UnderlyingSymbolExchange
-     */
-    'mic_code'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UnderlyingSymbolExchange
-     */
-    'name'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UnderlyingSymbolExchange
-     */
-    'timezone'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UnderlyingSymbolExchange
-     */
-    'start_time'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UnderlyingSymbolExchange
-     */
-    'close_time'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UnderlyingSymbolExchange
-     */
-    'suffix'?: string | null;
-    /**
-     *
-     * @type {boolean}
-     * @memberof UnderlyingSymbolExchange
-     */
-    'allows_cryptocurrency_symbols'?: boolean;
-}

package/dist/models/underlying-symbol-exchange.js

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

package/dist/models/underlying-symbol-type.d.ts

@@ -1,32 +0,0 @@
-/**
- * The type of security. For example, \"Common Stock\" or \"ETF\".
- * @export
- * @interface UnderlyingSymbolType
- */
-export interface UnderlyingSymbolType {
-    /**
-     * Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
-     * @type {string}
-     * @memberof UnderlyingSymbolType
-     */
-    'id'?: string;
-    /**
-     * A short code representing the security type. For example, \"cs\" for Common Stock. Here are some common values:   - `ad` - ADR   - `bnd` - Bond   - `cs` - Common Stock   - `cef` - Closed End Fund   - `crypto` - Cryptocurrency   - `et` - ETF   - `oef` - Open Ended Fund   - `pm` - Precious Metals   - `ps` - Preferred Stock   - `rt` - Right   - `struct` - Structured Product   - `ut` - Unit   - `wi` - When Issued   - `wt` - Warrant
-     * @type {string}
-     * @memberof UnderlyingSymbolType
-     */
-    'code'?: string;
-    /**
-     * A human-readable description of the security type. For example, \"Common Stock\" or \"ETF\".
-     * @type {string}
-     * @memberof UnderlyingSymbolType
-     */
-    'description'?: string;
-    /**
-     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
-     * @type {boolean}
-     * @memberof UnderlyingSymbolType
-     * @deprecated
-     */
-    'is_supported'?: boolean;
-}

package/dist/models/underlying-symbol-type.js

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

package/dist/models/underlying-symbol.d.ts

@@ -1,74 +0,0 @@
-import { Currency } from './currency';
-import { StockInstrumentFigiInstrument } from './stock-instrument-figi-instrument';
-import { SymbolCurrency } from './symbol-currency';
-import { UnderlyingSymbolExchange } from './underlying-symbol-exchange';
-import { UnderlyingSymbolType } from './underlying-symbol-type';
-/**
- * Symbol object for the underlying security of an option.
- * @export
- * @interface UnderlyingSymbol
- */
-export interface UnderlyingSymbol {
-    [key: string]: any;
-    /**
-     * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
-     * @type {string}
-     * @memberof UnderlyingSymbol
-     */
-    '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 UnderlyingSymbol
-     */
-    '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 UnderlyingSymbol
-     */
-    'raw_symbol'?: string;
-    /**
-     * A human-readable description of the security. This is usually the company name or ETF name.
-     * @type {string}
-     * @memberof UnderlyingSymbol
-     */
-    'description'?: string | null;
-    /**
-     *
-     * @type {SymbolCurrency}
-     * @memberof UnderlyingSymbol
-     */
-    'currency'?: SymbolCurrency;
-    /**
-     *
-     * @type {UnderlyingSymbolExchange}
-     * @memberof UnderlyingSymbol
-     */
-    'exchange'?: UnderlyingSymbolExchange;
-    /**
-     *
-     * @type {UnderlyingSymbolType}
-     * @memberof UnderlyingSymbol
-     */
-    'type'?: UnderlyingSymbolType;
-    /**
-     * 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 UnderlyingSymbol
-     */
-    'figi_code'?: string | null;
-    /**
-     *
-     * @type {StockInstrumentFigiInstrument}
-     * @memberof UnderlyingSymbol
-     */
-    'figi_instrument'?: StockInstrumentFigiInstrument | null;
-    /**
-     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
-     * @type {Array<Currency>}
-     * @memberof UnderlyingSymbol
-     * @deprecated
-     */
-    'currencies'?: Array<Currency>;
-}

package/dist/models/underlying-symbol.js

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

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

@@ -1,114 +0,0 @@
-import { AccountSimple } from './account-simple';
-import { AccountUniversalActivityCurrency } from './account-universal-activity-currency';
-import { AccountUniversalActivityOptionSymbol } from './account-universal-activity-option-symbol';
-import { AccountUniversalActivitySymbol } from './account-universal-activity-symbol';
-/**
- * A transaction or activity from an institution
- * @export
- * @interface UniversalActivity
- */
-export interface UniversalActivity {
-    [key: string]: any;
-    /**
-     * Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade.  Please note that this ID _can_ change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one.
-     * @type {string}
-     * @memberof UniversalActivity
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {AccountSimple}
-     * @memberof UniversalActivity
-     */
-    'account'?: AccountSimple;
-    /**
-     *
-     * @type {AccountUniversalActivitySymbol}
-     * @memberof UniversalActivity
-     */
-    'symbol'?: AccountUniversalActivitySymbol | null;
-    /**
-     *
-     * @type {AccountUniversalActivityOptionSymbol}
-     * @memberof UniversalActivity
-     */
-    'option_symbol'?: AccountUniversalActivityOptionSymbol | null;
-    /**
-     * The price of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions.
-     * @type {number}
-     * @memberof UniversalActivity
-     */
-    'price'?: number;
-    /**
-     * The number of units of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions.
-     * @type {number}
-     * @memberof UniversalActivity
-     */
-    'units'?: number;
-    /**
-     * The amount of the transaction denominated in `currency`. This can be positive or negative. In general, transactions that positively affect the account balance (like sell, deposits, dividends, etc) will have a positive amount, while transactions that negatively affect the account balance (like buy, withdrawals, fees, etc) will have a negative amount.
-     * @type {number}
-     * @memberof UniversalActivity
-     */
-    'amount'?: number | null;
-    /**
-     *
-     * @type {AccountUniversalActivityCurrency}
-     * @memberof UniversalActivity
-     */
-    'currency'?: AccountUniversalActivityCurrency;
-    /**
-     * A string representing the type of transaction. SnapTrade does a best effort to categorize the 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. `option_symbol` contains the related option contract info.   - `OPTIONASSIGNMENT` - Option assignment event. `option_symbol` contains the related option contract info.   - `OPTIONEXERCISE` - Option exercise event. `option_symbol` contains the related option contract info.
-     * @type {string}
-     * @memberof UniversalActivity
-     */
-    'type'?: string;
-    /**
-     * If an option `BUY` or `SELL` transaction, this further specifies the type of action. The possible values are: - BUY_TO_OPEN - BUY_TO_CLOSE - SELL_TO_OPEN - SELL_TO_CLOSE
-     * @type {string}
-     * @memberof UniversalActivity
-     */
-    'option_type'?: string;
-    /**
-     * A human-readable description of the transaction. This is usually the brokerage\'s description of the transaction.
-     * @type {string}
-     * @memberof UniversalActivity
-     */
-    'description'?: string;
-    /**
-     * The recorded time for the transaction. The granularity of this timestamp depends on the brokerage. Some brokerages provide the exact time of the transaction, while others provide only the date. Please check the [integrations page](https://support.snaptrade.com/brokerages-table?v=6fab8012ade6441fa0c6d9af9c55ce3a) for the specific brokerage to see the granularity of the timestamps. Note that even though the field is named `trade_date`, it can represent any type of transaction, not just trades.
-     * @type {string}
-     * @memberof UniversalActivity
-     */
-    'trade_date'?: string | null;
-    /**
-     * The date on which the transaction is settled.
-     * @type {string}
-     * @memberof UniversalActivity
-     */
-    'settlement_date'?: string;
-    /**
-     * Any fee associated with the transaction if provided by the brokerage.
-     * @type {number}
-     * @memberof UniversalActivity
-     */
-    'fee'?: number;
-    /**
-     * The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -> currency)
-     * @type {number}
-     * @memberof UniversalActivity
-     */
-    'fx_rate'?: number | null;
-    /**
-     * The institution that the transaction is associated with. This is usually the brokerage name.
-     * @type {string}
-     * @memberof UniversalActivity
-     */
-    'institution'?: string;
-    /**
-     * Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same `external_reference_id`
-     * @type {string}
-     * @memberof UniversalActivity
-     */
-    'external_reference_id'?: string | null;
-}

package/dist/models/universal-activity.js

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

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

@@ -1,74 +0,0 @@
-import { Currency } from './currency';
-import { SecurityType } from './security-type';
-import { StockInstrumentFigiInstrument } from './stock-instrument-figi-instrument';
-import { SymbolCurrency } from './symbol-currency';
-import { SymbolExchange } from './symbol-exchange';
-/**
- * Uniquely describes a single security + exchange combination across all brokerages.
- * @export
- * @interface UniversalSymbol
- */
-export interface UniversalSymbol {
-    [key: string]: any;
-    /**
-     * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
-     * @type {string}
-     * @memberof UniversalSymbol
-     */
-    '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 UniversalSymbol
-     */
-    '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 UniversalSymbol
-     */
-    'raw_symbol': string;
-    /**
-     * A human-readable description of the security. This is usually the company name or ETF name.
-     * @type {string}
-     * @memberof UniversalSymbol
-     */
-    'description'?: string | null;
-    /**
-     *
-     * @type {SymbolCurrency}
-     * @memberof UniversalSymbol
-     */
-    'currency': SymbolCurrency;
-    /**
-     *
-     * @type {SymbolExchange}
-     * @memberof UniversalSymbol
-     */
-    'exchange'?: SymbolExchange;
-    /**
-     *
-     * @type {SecurityType}
-     * @memberof UniversalSymbol
-     */
-    '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 UniversalSymbol
-     */
-    'figi_code'?: string | null;
-    /**
-     *
-     * @type {StockInstrumentFigiInstrument}
-     * @memberof UniversalSymbol
-     */
-    'figi_instrument'?: StockInstrumentFigiInstrument | null;
-    /**
-     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
-     * @type {Array<Currency>}
-     * @memberof UniversalSymbol
-     * @deprecated
-     */
-    'currencies': Array<Currency>;
-}