snaptrade-typescript-sdk 9.0.35 → 9.0.37

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

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

@@ -1,8 +1,8 @@
 import { Currency } from './currency';
 import { SecurityType } from './security-type';
+import { SymbolCurrency } from './symbol-currency';
+import { SymbolExchange } from './symbol-exchange';
 import { SymbolFigiInstrument } from './symbol-figi-instrument';
-import { UniversalSymbolCurrency } from './universal-symbol-currency';
-import { UniversalSymbolExchange } from './universal-symbol-exchange';
 /**
  * Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated.
  * @export
@@ -35,16 +35,16 @@ export interface AccountOrderRecordUniversalSymbol {
     'description'?: string | null;
     /**
      *
-     * @type {UniversalSymbolCurrency}
+     * @type {SymbolCurrency}
      * @memberof AccountOrderRecordUniversalSymbol
      */
-    'currency': UniversalSymbolCurrency;
+    'currency': SymbolCurrency;
     /**
      *
-     * @type {UniversalSymbolExchange}
+     * @type {SymbolExchange}
      * @memberof AccountOrderRecordUniversalSymbol
      */
-    'exchange'?: UniversalSymbolExchange;
+    'exchange'?: SymbolExchange;
     /**
      *
      * @type {SecurityType}

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

@@ -94,7 +94,7 @@ export interface 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.
+     * 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
      */

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

@@ -1,25 +1,25 @@
 import { AccountSyncStatus } from './account-sync-status';
 /**
- * SnapTradeUser Investment Account
+ * 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
      */

package/dist/models/account.d.ts

@@ -1,14 +1,14 @@
 import { AccountBalance } from './account-balance';
 import { AccountSyncStatus } from './account-sync-status';
 /**
- * A single brokerage account at a financial institution.
+ * A single account at a brokerage.
  * @export
  * @interface Account
  */
 export interface Account {
     [key: string]: any;
     /**
-     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated. If you want a stable identifier for the account, use the `number` field.
+     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated.
      * @type {string}
      * @memberof Account
      */
@@ -27,31 +27,31 @@ export interface Account {
      */
     'portfolio_group'?: string;
     /**
-     * A display name for the account. Either assigned by the user or by the financial institution itself. For certain institutions, SnapTrade appends the institution name to the account name for clarity.
+     * 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 Account
      */
     'name'?: string | null;
     /**
-     * The account number assigned by the financial institution.
+     * The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
      * @type {string}
      * @memberof Account
      */
     'number'?: string;
     /**
-     * The name of the financial institution that holds the account.
+     * The name of the brokerage that holds the account.
      * @type {string}
      * @memberof Account
      */
     'institution_name'?: string;
     /**
-     * Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the financial institution.
+     * Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the brokerage.
      * @type {string}
      * @memberof Account
      */
     'created_date'?: string;
     /**
-     * Additional information about the account, such as account type, status, etc. This information is specific to the financial institution and there\'s no standard format for this data. Please use at your own risk.
+     * Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there\'s no standard format for this data. Please use at your own risk.
      * @type {{ [key: string]: any; }}
      * @memberof Account
      * @deprecated

package/dist/models/delete-user-response.d.ts

@@ -1,16 +1,22 @@
 /**
- * Response when delete user is successful
+ *
  * @export
  * @interface DeleteUserResponse
  */
 export interface DeleteUserResponse {
     [key: string]: any;
     /**
-     * Delete status
+     * This is always `deleted` when a user is queued for deletion.
      * @type {string}
      * @memberof DeleteUserResponse
      */
     'status'?: string;
+    /**
+     * Human friendly message about the deletion status.
+     * @type {string}
+     * @memberof DeleteUserResponse
+     */
+    'detail'?: string;
     /**
      * SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
      * @type {string}

package/dist/models/index.d.ts

@@ -79,6 +79,8 @@ export * from './strategy-quotes';
 export * from './strategy-quotes-greek';
 export * from './sub-period-return-rate';
 export * from './symbol';
+export * from './symbol-currency';
+export * from './symbol-exchange';
 export * from './symbol-figi-instrument';
 export * from './symbol-query';
 export * from './symbols-quotes-inner';
@@ -90,8 +92,9 @@ export * from './underlying-symbol';
 export * from './underlying-symbol-exchange';
 export * from './underlying-symbol-type';
 export * from './universal-activity';
+export * from './universal-activity-currency';
+export * from './universal-activity-option-symbol';
+export * from './universal-activity-symbol';
 export * from './universal-symbol';
-export * from './universal-symbol-currency';
-export * from './universal-symbol-exchange';
 export * from './user-idand-secret';
 export * from './validated-trade-body';

package/dist/models/index.js

@@ -95,6 +95,8 @@ __exportStar(require("./strategy-quotes"), exports);
 __exportStar(require("./strategy-quotes-greek"), exports);
 __exportStar(require("./sub-period-return-rate"), exports);
 __exportStar(require("./symbol"), exports);
+__exportStar(require("./symbol-currency"), exports);
+__exportStar(require("./symbol-exchange"), exports);
 __exportStar(require("./symbol-figi-instrument"), exports);
 __exportStar(require("./symbol-query"), exports);
 __exportStar(require("./symbols-quotes-inner"), exports);
@@ -106,8 +108,9 @@ __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-activity-currency"), exports);
+__exportStar(require("./universal-activity-option-symbol"), exports);
+__exportStar(require("./universal-activity-symbol"), exports);
 __exportStar(require("./universal-symbol"), exports);
-__exportStar(require("./universal-symbol-currency"), exports);
-__exportStar(require("./universal-symbol-exchange"), exports);
 __exportStar(require("./user-idand-secret"), exports);
 __exportStar(require("./validated-trade-body"), exports);

package/dist/models/login-redirect-uri.d.ts

@@ -5,13 +5,13 @@
  */
 export interface LoginRedirectURI {
     /**
-     *
-     * @type {any}
+     * Connection Portal link to redirect user to connect a brokerage account.
+     * @type {string}
      * @memberof LoginRedirectURI
      */
-    'redirectURI'?: any;
+    'redirectURI'?: string;
     /**
-     *
+     * ID to identify the connection portal session.
      * @type {string}
      * @memberof LoginRedirectURI
      */

package/dist/models/snap-trade-login-user-request-body.d.ts

@@ -5,37 +5,37 @@
  */
 export interface SnapTradeLoginUserRequestBody {
     /**
-     * Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
+     * Slug of the brokerage to connect the user to. See [the integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=3cfea70ef4254afc89704e47275a7a9a&pvs=4) for a list of supported brokerages and their slugs.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */
     'broker'?: string;
     /**
-     * When set to True, user will be redirected back to the partner\'s site instead of the connection portal
+     * When set to `true`, user will be redirected back to the partner\'s site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
      * @type {boolean}
      * @memberof SnapTradeLoginUserRequestBody
      */
     'immediateRedirect'?: boolean;
     /**
-     * URL to redirect the user to after the user connects their brokerage account
+     * URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */
     'customRedirect'?: string;
     /**
-     * The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
+     * The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](https://docs.snaptrade.com/docs/fix-broken-connections) for more information.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */
     'reconnect'?: string;
     /**
-     * Sets whether the connection should be read or trade
+     * Sets whether the connection should be read-only or trade-enabled.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */
     'connectionType'?: SnapTradeLoginUserRequestBodyConnectionTypeEnum;
     /**
-     * Sets the version of the connection portal to render, with a default to \'v3\'
+     * Sets the version of the connection portal to render.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */

package/dist/models/{universal-symbol-currency.d.ts → symbol-currency.d.ts}

@@ -1,25 +1,25 @@
 /**
  * The currency in which the security is traded.
  * @export
- * @interface UniversalSymbolCurrency
+ * @interface SymbolCurrency
  */
-export interface UniversalSymbolCurrency {
+export interface SymbolCurrency {
     /**
      * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
      * @type {string}
-     * @memberof UniversalSymbolCurrency
+     * @memberof SymbolCurrency
      */
     'id'?: string;
     /**
      * The ISO-4217 currency code for the currency.
      * @type {string}
-     * @memberof UniversalSymbolCurrency
+     * @memberof SymbolCurrency
      */
     'code'?: string;
     /**
      * A human-friendly name of the currency.
      * @type {string}
-     * @memberof UniversalSymbolCurrency
+     * @memberof SymbolCurrency
      */
     'name'?: string;
 }

package/dist/models/{universal-symbol-exchange.d.ts → symbol-exchange.d.ts}

@@ -1,55 +1,55 @@
 /**
  * The exchange on which the security is listed and traded.
  * @export
- * @interface UniversalSymbolExchange
+ * @interface SymbolExchange
  */
-export interface UniversalSymbolExchange {
+export interface SymbolExchange {
     /**
      * Unique ID for the exchange in SnapTrade.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'id'?: string;
     /**
      * A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'code'?: string;
     /**
      * The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'mic_code'?: string;
     /**
      * The full name of the exchange.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'name'?: string;
     /**
      * The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'timezone'?: string;
     /**
      * The time when the exchange opens for trading.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'start_time'?: string;
     /**
      * The time when the exchange closes for trading.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     '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 UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'suffix'?: string | null;
 }

package/dist/models/symbol.d.ts

@@ -1,50 +1,50 @@
-import { Currency } from './currency';
-import { Exchange } from './exchange';
 import { SecurityType } from './security-type';
+import { SymbolCurrency } from './symbol-currency';
+import { SymbolExchange } from './symbol-exchange';
 import { SymbolFigiInstrument } from './symbol-figi-instrument';
 /**
- * Symbol
+ * Uniquely describes a single security + exchange combination across all brokerages.
  * @export
  * @interface Symbol
  */
 export interface Symbol {
     [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 Symbol
      */
     '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 Symbol
      */
     '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 Symbol
      */
     'raw_symbol'?: string;
     /**
-     *
+     * A human-readable description of the security. This is usually the company name or ETF name.
      * @type {string}
      * @memberof Symbol
      */
-    'name'?: string;
+    'description'?: string | null;
     /**
      *
-     * @type {Currency}
+     * @type {SymbolCurrency}
      * @memberof Symbol
      */
-    'currency'?: Currency;
+    'currency'?: SymbolCurrency;
     /**
      *
-     * @type {Exchange}
+     * @type {SymbolExchange}
      * @memberof Symbol
      */
-    'exchange'?: Exchange;
+    'exchange'?: SymbolExchange;
     /**
      *
      * @type {SecurityType}
@@ -52,7 +52,7 @@ export interface Symbol {
      */
     '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 Symbol
      */

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

@@ -1,8 +1,8 @@
 import { Currency } from './currency';
+import { SymbolCurrency } from './symbol-currency';
 import { SymbolFigiInstrument } from './symbol-figi-instrument';
 import { UnderlyingSymbolExchange } from './underlying-symbol-exchange';
 import { UnderlyingSymbolType } from './underlying-symbol-type';
-import { UniversalSymbolCurrency } from './universal-symbol-currency';
 /**
  * Symbol object for the underlying security of an option.
  * @export
@@ -36,10 +36,10 @@ export interface UnderlyingSymbol {
     'description'?: string | null;
     /**
      *
-     * @type {UniversalSymbolCurrency}
+     * @type {SymbolCurrency}
      * @memberof UnderlyingSymbol
      */
-    'currency'?: UniversalSymbolCurrency;
+    'currency'?: SymbolCurrency;
     /**
      *
      * @type {UnderlyingSymbolExchange}

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

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

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

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

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

@@ -0,0 +1,52 @@
+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 UniversalActivityOptionSymbol
+ */
+export interface UniversalActivityOptionSymbol {
+    /**
+     * Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+     * @type {string}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    'id': string;
+    /**
+     * The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
+     * @type {string}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    'ticker': string;
+    /**
+     * The type of option. Either \"CALL\" or \"PUT\".
+     * @type {string}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    'option_type': UniversalActivityOptionSymbolOptionTypeEnum;
+    /**
+     * The option strike price.
+     * @type {number}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    'strike_price': number;
+    /**
+     * The option expiration date.
+     * @type {string}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    '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 UniversalActivityOptionSymbol
+     */
+    'is_mini_option'?: boolean;
+    /**
+     *
+     * @type {UnderlyingSymbol}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    'underlying_symbol': UnderlyingSymbol;
+}
+type UniversalActivityOptionSymbolOptionTypeEnum = 'CALL' | 'PUT';
+export {};

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

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

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

@@ -0,0 +1,65 @@
+import { SecurityType } from './security-type';
+import { SymbolCurrency } from './symbol-currency';
+import { SymbolExchange } from './symbol-exchange';
+import { SymbolFigiInstrument } from './symbol-figi-instrument';
+/**
+ * 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 UniversalActivitySymbol
+ */
+export interface UniversalActivitySymbol {
+    /**
+     * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+     * @type {string}
+     * @memberof UniversalActivitySymbol
+     */
+    '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 UniversalActivitySymbol
+     */
+    '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 UniversalActivitySymbol
+     */
+    'raw_symbol'?: string;
+    /**
+     * A human-readable description of the security. This is usually the company name or ETF name.
+     * @type {string}
+     * @memberof UniversalActivitySymbol
+     */
+    'description'?: string | null;
+    /**
+     *
+     * @type {SymbolCurrency}
+     * @memberof UniversalActivitySymbol
+     */
+    'currency'?: SymbolCurrency;
+    /**
+     *
+     * @type {SymbolExchange}
+     * @memberof UniversalActivitySymbol
+     */
+    'exchange'?: SymbolExchange;
+    /**
+     *
+     * @type {SecurityType}
+     * @memberof UniversalActivitySymbol
+     */
+    '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 UniversalActivitySymbol
+     */
+    'figi_code'?: string | null;
+    /**
+     *
+     * @type {SymbolFigiInstrument}
+     * @memberof UniversalActivitySymbol
+     */
+    'figi_instrument'?: SymbolFigiInstrument | null;
+}

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

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