snaptrade-typescript-sdk 9.0.32 → 9.0.33

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

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

@@ -5,7 +5,7 @@ import { Position } from './position';
 import { SnapTradeHoldingsAccountAccountId } from './snap-trade-holdings-account-account-id';
 import { SnapTradeHoldingsTotalValue } from './snap-trade-holdings-total-value';
 /**
- * A wrapper object containing holdings information for a single account
+ * A wrapper object containing holdings information for a single account.
  * @export
  * @interface AccountHoldingsAccount
  */

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

@@ -1,5 +1,5 @@
 /**
- *
+ * Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
  * @export
  * @enum {string}
  */

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

@@ -2,28 +2,29 @@ import { AccountOrderRecordStatus } from './account-order-record-status';
 import { OptionsSymbol } from './options-symbol';
 import { UniversalSymbol } from './universal-symbol';
 /**
- * Record of order in brokerageaccount
+ * Describes a single recent order in an account.
  * @export
  * @interface AccountOrderRecord
  */
 export interface AccountOrderRecord {
     [key: string]: any;
     /**
-     * Order id returned by brokerage
+     * 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;
     /**
-     *
+     * Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
      * @type {AccountOrderRecordStatus}
      * @memberof AccountOrderRecord
      */
     'status'?: AccountOrderRecordStatus;
     /**
-     *
+     * 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;
     /**

package/dist/models/exchange.d.ts

@@ -1,54 +1,54 @@
 /**
- * Stock Exchange
+ * Describes a single stock or crypto exchange.
  * @export
  * @interface Exchange
  */
 export interface Exchange {
     [key: string]: any;
     /**
-     *
+     * Unique ID for the exchange in SnapTrade.
      * @type {string}
      * @memberof Exchange
      */
     'id'?: string;
     /**
-     *
+     * A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
      * @type {string}
      * @memberof Exchange
      */
     'code'?: string;
     /**
-     *
+     * The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
      * @type {string}
      * @memberof Exchange
      */
     'mic_code'?: string;
     /**
-     *
+     * The full name of the exchange.
      * @type {string}
      * @memberof Exchange
      */
     'name'?: string;
     /**
-     *
+     * The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
      * @type {string}
      * @memberof Exchange
      */
     'timezone'?: string;
     /**
-     *
+     * The time when the exchange opens for trading.
      * @type {string}
      * @memberof Exchange
      */
     'start_time'?: string;
     /**
-     *
+     * The time when the exchange closes for trading.
      * @type {string}
      * @memberof Exchange
      */
     'close_time'?: string;
     /**
-     *
+     * The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail.
      * @type {string}
      * @memberof Exchange
      */

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

@@ -1,18 +1,18 @@
 /**
- * Open FIGI Identifiers
+ * Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information.
  * @export
  * @interface FigiInstrument
  */
 export interface FigiInstrument {
     [key: string]: any;
     /**
-     *
+     * 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.
      * @type {string}
      * @memberof FigiInstrument
      */
     'figi_code'?: string | null;
     /**
-     *
+     * This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
      * @type {string}
      * @memberof FigiInstrument
      */

package/dist/models/index.d.ts

@@ -15,14 +15,9 @@ export * from './brokerage';
 export * from './brokerage-authorization';
 export * from './brokerage-authorization-disabled-confirmation';
 export * from './brokerage-authorization-refresh-confirmation';
-export * from './brokerage-authorization-type';
 export * from './brokerage-authorization-type-read-only';
 export * from './brokerage-authorization-type-read-only-brokerage';
-export * from './brokerage-symbol';
-export * from './brokerage-symbol-option-symbol';
-export * from './brokerage-symbol-symbol';
 export * from './brokerage-type';
-export * from './calculated-trade';
 export * from './cash-restriction';
 export * from './connections-session-events200-response-inner';
 export * from './currency';
@@ -32,10 +27,8 @@ export * from './encrypted-response';
 export * from './encrypted-response-encrypted-message-data';
 export * from './exchange';
 export * from './exchange-rate-pairs';
-export * from './excluded-asset';
 export * from './figi-instrument';
 export * from './holdings-status';
-export * from './jwt';
 export * from './login-redirect-uri';
 export * from './manual-trade';
 export * from './manual-trade-and-impact';
@@ -51,13 +44,6 @@ export * from './model403-failed-request-response';
 export * from './model403-feature-not-enabled-response';
 export * from './model404-failed-request-response';
 export * from './model500-unexpected-exception-response';
-export * from './model-asset-class';
-export * from './model-asset-class-details';
-export * from './model-asset-class-target';
-export * from './model-portfolio';
-export * from './model-portfolio-asset-class';
-export * from './model-portfolio-details';
-export * from './model-portfolio-security';
 export * from './monthly-dividends';
 export * from './net-contributions';
 export * from './net-dividend';
@@ -78,16 +64,10 @@ export * from './order-type-strict';
 export * from './partner-data';
 export * from './past-value';
 export * from './performance-custom';
-export * from './portfolio-group';
-export * from './portfolio-group-info';
-export * from './portfolio-group-position';
-export * from './portfolio-group-settings';
 export * from './position';
 export * from './position-symbol';
-export * from './redirect-tokenand-pin';
 export * from './security-type';
 export * from './session-event';
-export * from './snap-trade-apidisclaimer-accept-status';
 export * from './snap-trade-holdings-account';
 export * from './snap-trade-holdings-account-account-id';
 export * from './snap-trade-holdings-account-account-id-balance';
@@ -95,11 +75,6 @@ export * from './snap-trade-holdings-total-value';
 export * from './snap-trade-login-user-request-body';
 export * from './snap-trade-register-user-request-body';
 export * from './status';
-export * from './strategy-impact';
-export * from './strategy-impact-legs-inner';
-export * from './strategy-order-place';
-export * from './strategy-order-place-orders-inner';
-export * from './strategy-order-place-orders-inner-legs-inner';
 export * from './strategy-order-record';
 export * from './strategy-quotes';
 export * from './strategy-quotes-greek';
@@ -108,18 +83,16 @@ export * from './symbol';
 export * from './symbol-figi-instrument';
 export * from './symbol-query';
 export * from './symbols-quotes-inner';
-export * from './target-asset';
 export * from './time-in-force-strict';
-export * from './trade';
-export * from './trade-execution-status';
-export * from './trade-impact';
 export * from './trading-cancel-user-account-order-request';
 export * from './transactions-status';
 export * from './usexchange';
 export * from './underlying-symbol';
+export * from './underlying-symbol-exchange';
+export * from './underlying-symbol-type';
 export * from './universal-activity';
 export * from './universal-symbol';
-export * from './user-error-log';
+export * from './universal-symbol-currency';
+export * from './universal-symbol-exchange';
 export * from './user-idand-secret';
-export * from './user-settings';
 export * from './validated-trade-body';

package/dist/models/index.js

@@ -31,14 +31,9 @@ __exportStar(require("./brokerage"), exports);
 __exportStar(require("./brokerage-authorization"), exports);
 __exportStar(require("./brokerage-authorization-disabled-confirmation"), exports);
 __exportStar(require("./brokerage-authorization-refresh-confirmation"), exports);
-__exportStar(require("./brokerage-authorization-type"), exports);
 __exportStar(require("./brokerage-authorization-type-read-only"), exports);
 __exportStar(require("./brokerage-authorization-type-read-only-brokerage"), exports);
-__exportStar(require("./brokerage-symbol"), exports);
-__exportStar(require("./brokerage-symbol-option-symbol"), exports);
-__exportStar(require("./brokerage-symbol-symbol"), exports);
 __exportStar(require("./brokerage-type"), exports);
-__exportStar(require("./calculated-trade"), exports);
 __exportStar(require("./cash-restriction"), exports);
 __exportStar(require("./connections-session-events200-response-inner"), exports);
 __exportStar(require("./currency"), exports);
@@ -48,10 +43,8 @@ __exportStar(require("./encrypted-response"), exports);
 __exportStar(require("./encrypted-response-encrypted-message-data"), exports);
 __exportStar(require("./exchange"), exports);
 __exportStar(require("./exchange-rate-pairs"), exports);
-__exportStar(require("./excluded-asset"), exports);
 __exportStar(require("./figi-instrument"), exports);
 __exportStar(require("./holdings-status"), exports);
-__exportStar(require("./jwt"), exports);
 __exportStar(require("./login-redirect-uri"), exports);
 __exportStar(require("./manual-trade"), exports);
 __exportStar(require("./manual-trade-and-impact"), exports);
@@ -67,13 +60,6 @@ __exportStar(require("./model403-failed-request-response"), exports);
 __exportStar(require("./model403-feature-not-enabled-response"), exports);
 __exportStar(require("./model404-failed-request-response"), exports);
 __exportStar(require("./model500-unexpected-exception-response"), exports);
-__exportStar(require("./model-asset-class"), exports);
-__exportStar(require("./model-asset-class-details"), exports);
-__exportStar(require("./model-asset-class-target"), exports);
-__exportStar(require("./model-portfolio"), exports);
-__exportStar(require("./model-portfolio-asset-class"), exports);
-__exportStar(require("./model-portfolio-details"), exports);
-__exportStar(require("./model-portfolio-security"), exports);
 __exportStar(require("./monthly-dividends"), exports);
 __exportStar(require("./net-contributions"), exports);
 __exportStar(require("./net-dividend"), exports);
@@ -94,16 +80,10 @@ __exportStar(require("./order-type-strict"), exports);
 __exportStar(require("./partner-data"), exports);
 __exportStar(require("./past-value"), exports);
 __exportStar(require("./performance-custom"), exports);
-__exportStar(require("./portfolio-group"), exports);
-__exportStar(require("./portfolio-group-info"), exports);
-__exportStar(require("./portfolio-group-position"), exports);
-__exportStar(require("./portfolio-group-settings"), exports);
 __exportStar(require("./position"), exports);
 __exportStar(require("./position-symbol"), exports);
-__exportStar(require("./redirect-tokenand-pin"), exports);
 __exportStar(require("./security-type"), exports);
 __exportStar(require("./session-event"), exports);
-__exportStar(require("./snap-trade-apidisclaimer-accept-status"), exports);
 __exportStar(require("./snap-trade-holdings-account"), exports);
 __exportStar(require("./snap-trade-holdings-account-account-id"), exports);
 __exportStar(require("./snap-trade-holdings-account-account-id-balance"), exports);
@@ -111,11 +91,6 @@ __exportStar(require("./snap-trade-holdings-total-value"), exports);
 __exportStar(require("./snap-trade-login-user-request-body"), exports);
 __exportStar(require("./snap-trade-register-user-request-body"), exports);
 __exportStar(require("./status"), exports);
-__exportStar(require("./strategy-impact"), exports);
-__exportStar(require("./strategy-impact-legs-inner"), exports);
-__exportStar(require("./strategy-order-place"), exports);
-__exportStar(require("./strategy-order-place-orders-inner"), exports);
-__exportStar(require("./strategy-order-place-orders-inner-legs-inner"), exports);
 __exportStar(require("./strategy-order-record"), exports);
 __exportStar(require("./strategy-quotes"), exports);
 __exportStar(require("./strategy-quotes-greek"), exports);
@@ -124,18 +99,16 @@ __exportStar(require("./symbol"), exports);
 __exportStar(require("./symbol-figi-instrument"), exports);
 __exportStar(require("./symbol-query"), exports);
 __exportStar(require("./symbols-quotes-inner"), exports);
-__exportStar(require("./target-asset"), exports);
 __exportStar(require("./time-in-force-strict"), exports);
-__exportStar(require("./trade"), exports);
-__exportStar(require("./trade-execution-status"), exports);
-__exportStar(require("./trade-impact"), exports);
 __exportStar(require("./trading-cancel-user-account-order-request"), exports);
 __exportStar(require("./transactions-status"), exports);
 __exportStar(require("./usexchange"), exports);
 __exportStar(require("./underlying-symbol"), exports);
+__exportStar(require("./underlying-symbol-exchange"), exports);
+__exportStar(require("./underlying-symbol-type"), exports);
 __exportStar(require("./universal-activity"), exports);
 __exportStar(require("./universal-symbol"), exports);
-__exportStar(require("./user-error-log"), exports);
+__exportStar(require("./universal-symbol-currency"), exports);
+__exportStar(require("./universal-symbol-exchange"), exports);
 __exportStar(require("./user-idand-secret"), exports);
-__exportStar(require("./user-settings"), exports);
 __exportStar(require("./validated-trade-body"), exports);

package/dist/models/option-brokerage-symbol.d.ts

@@ -1,21 +1,23 @@
 import { OptionsSymbol } from './options-symbol';
 /**
- * Option Brokerage symbol
+ * Uniquely describes a security for the option position within an account. The distinction between this and the `option_symbol` child property is that this object is specific to a position within an account, while the `option_symbol` child property is universal across all brokerage accounts. The caller should rely on the `option_symbol` child property for most use cases.
  * @export
  * @interface OptionBrokerageSymbol
  */
 export interface OptionBrokerageSymbol {
     [key: string]: any;
     /**
-     *
+     * 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 OptionBrokerageSymbol
+     * @deprecated
      */
     'id'?: string;
     /**
-     *
+     * This field is deprecated and the caller should use the `option_symbol` child property\'s `description` instead.
      * @type {string}
      * @memberof OptionBrokerageSymbol
+     * @deprecated
      */
     'description'?: string;
     /**

package/dist/models/options-position-currency.d.ts

@@ -1,5 +1,5 @@
 /**
- *
+ * The currency of the price. This field is deprecated and will be removed in a future version. The currency of the price is determined by the currency of the underlying security.
  * @export
  * @interface OptionsPositionCurrency
  */

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

@@ -20,7 +20,7 @@ export interface OptionsPosition {
      */
     'price'?: number | null;
     /**
-     * The number of contracts for this option position.
+     * The number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position.
      * @type {number}
      * @memberof OptionsPosition
      */
@@ -29,6 +29,7 @@ export interface OptionsPosition {
      *
      * @type {OptionsPositionCurrency}
      * @memberof OptionsPosition
+     * @deprecated
      */
     'currency'?: OptionsPositionCurrency | null;
     /**

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

@@ -1,43 +1,43 @@
 import { UnderlyingSymbol } from './underlying-symbol';
 /**
- * Options Symbol
+ * Uniquely describes an option security + exchange combination across all brokerages.
  * @export
  * @interface OptionsSymbol
  */
 export interface OptionsSymbol {
     [key: string]: any;
     /**
-     *
+     * Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
      * @type {string}
      * @memberof OptionsSymbol
      */
     'id': string;
     /**
-     *
+     * The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
      * @type {string}
      * @memberof OptionsSymbol
      */
     'ticker': string;
     /**
-     *
+     * The type of option. Either \"CALL\" or \"PUT\".
      * @type {string}
      * @memberof OptionsSymbol
      */
     'option_type': OptionsSymbolOptionTypeEnum;
     /**
-     *
+     * The option strike price.
      * @type {number}
      * @memberof OptionsSymbol
      */
     'strike_price': number;
     /**
-     *
+     * The option expiration date.
      * @type {string}
      * @memberof OptionsSymbol
      */
     '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 OptionsSymbol
      */
@@ -48,18 +48,6 @@ export interface OptionsSymbol {
      * @memberof OptionsSymbol
      */
     'underlying_symbol': UnderlyingSymbol;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionsSymbol
-     */
-    'local_id'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionsSymbol
-     */
-    'exchange_id'?: string;
 }
 type OptionsSymbolOptionTypeEnum = 'CALL' | 'PUT';
 export {};

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

@@ -1,21 +1,23 @@
 import { UniversalSymbol } from './universal-symbol';
 /**
- * Symbol returned in position object
+ * Uniquely describes a security for the position within an account. The distinction between this and the `symbol` child property is that this object is specific to a position within an account, while the `symbol` child property is universal across all brokerage accounts. The caller should rely on the `symbol` child property for most use cases.
  * @export
  * @interface PositionSymbol
  */
 export interface PositionSymbol {
     [key: string]: any;
     /**
-     *
+     * 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 PositionSymbol
+     * @deprecated
      */
     'id'?: string;
     /**
-     *
+     * This field is deprecated and the caller should use the `symbol` child property\'s `description` instead.
      * @type {string}
      * @memberof PositionSymbol
+     * @deprecated
      */
     'description'?: string;
     /**
@@ -25,21 +27,24 @@ export interface PositionSymbol {
      */
     'symbol'?: UniversalSymbol;
     /**
-     *
+     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
      * @type {string}
      * @memberof PositionSymbol
+     * @deprecated
      */
     'local_id'?: string | null;
     /**
-     *
+     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
      * @type {boolean}
      * @memberof PositionSymbol
+     * @deprecated
      */
     'is_quotable'?: boolean;
     /**
-     *
+     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
      * @type {boolean}
      * @memberof PositionSymbol
+     * @deprecated
      */
     'is_tradable'?: boolean;
 }

package/dist/models/security-type.d.ts

@@ -1,32 +1,33 @@
 /**
- * Security Type
+ * The type of security. For example, \"Common Stock\" or \"ETF\".
  * @export
  * @interface SecurityType
  */
 export interface SecurityType {
     [key: string]: any;
     /**
-     *
+     * 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 SecurityType
      */
     '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   et - ETF   oef - Open Ended Fund   ps - Preferred Stock   rt - Right   struct - Structured Product   ut - Unit   wi - When Issued   wt - Warrant
      * @type {string}
      * @memberof SecurityType
      */
     'code'?: string;
     /**
-     *
+     * A human-readable description of the security type. For example, \"Common Stock\" or \"ETF\".
      * @type {string}
      * @memberof SecurityType
      */
     'description'?: string;
     /**
-     *
+     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
      * @type {boolean}
      * @memberof SecurityType
+     * @deprecated
      */
     'is_supported'?: boolean;
 }

package/dist/models/symbol-figi-instrument.d.ts

@@ -5,13 +5,13 @@
  */
 export interface SymbolFigiInstrument {
     /**
-     *
+     * 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.
      * @type {string}
      * @memberof SymbolFigiInstrument
      */
     'figi_code'?: string | null;
     /**
-     *
+     * This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
      * @type {string}
      * @memberof SymbolFigiInstrument
      */

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

@@ -0,0 +1,61 @@
+/**
+ * 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-type.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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   et - ETF   oef - Open Ended Fund   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 usecase for this.
+     * @type {boolean}
+     * @memberof UnderlyingSymbolType
+     * @deprecated
+     */
+    'is_supported'?: boolean;
+}