snaptrade-typescript-sdk 9.0.32 → 9.0.33

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

@@ -1,58 +1,66 @@
 import { Currency } from './currency';
-import { SecurityType } from './security-type';
 import { SymbolFigiInstrument } from './symbol-figi-instrument';
-import { USExchange } from './usexchange';
+import { UnderlyingSymbolExchange } from './underlying-symbol-exchange';
+import { UnderlyingSymbolType } from './underlying-symbol-type';
+import { UniversalSymbolCurrency } from './universal-symbol-currency';
 /**
- * Underlying Symbol
+ * 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 {Currency}
+     * @type {UniversalSymbolCurrency}
      * @memberof UnderlyingSymbol
      */
-    'currency'?: Currency;
+    'currency'?: UniversalSymbolCurrency;
     /**
      *
-     * @type {USExchange}
+     * @type {UnderlyingSymbolExchange}
      * @memberof UnderlyingSymbol
      */
-    'exchange'?: USExchange;
+    'exchange'?: UnderlyingSymbolExchange;
     /**
      *
-     * @type {SecurityType}
+     * @type {UnderlyingSymbolType}
      * @memberof UnderlyingSymbol
      */
-    'type'?: SecurityType;
+    'type'?: UnderlyingSymbolType;
     /**
-     *
+     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
      * @type {Array<Currency>}
      * @memberof UnderlyingSymbol
+     * @deprecated
      */
     'currencies'?: Array<Currency>;
     /**
-     *
+     * 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
      */

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

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

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

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

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

@@ -1,50 +1,51 @@
 import { Currency } from './currency';
-import { Exchange } from './exchange';
 import { SecurityType } from './security-type';
 import { SymbolFigiInstrument } from './symbol-figi-instrument';
+import { UniversalSymbolCurrency } from './universal-symbol-currency';
+import { UniversalSymbolExchange } from './universal-symbol-exchange';
 /**
- * Universal symbol
+ * 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 {Currency}
+     * @type {UniversalSymbolCurrency}
      * @memberof UniversalSymbol
      */
-    'currency': Currency;
+    'currency': UniversalSymbolCurrency;
     /**
      *
-     * @type {Exchange}
+     * @type {UniversalSymbolExchange}
      * @memberof UniversalSymbol
      */
-    'exchange'?: Exchange;
+    'exchange'?: UniversalSymbolExchange;
     /**
      *
      * @type {SecurityType}
@@ -52,13 +53,14 @@ export interface UniversalSymbol {
      */
     'type': SecurityType;
     /**
-     *
+     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
      * @type {Array<Currency>}
      * @memberof UniversalSymbol
+     * @deprecated
      */
     'currencies': Array<Currency>;
     /**
-     *
+     * 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
      */

package/package.json

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

package/dist/models/brokerage-authorization-type.d.ts

@@ -1,16 +0,0 @@
-/**
- *
- * @export
- * @interface BrokerageAuthorizationType
- */
-export interface BrokerageAuthorizationType {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageAuthorizationType
-     */
-    'type'?: BrokerageAuthorizationTypeTypeEnum;
-}
-type BrokerageAuthorizationTypeTypeEnum = 'read' | 'trade';
-export {};

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

@@ -1,64 +0,0 @@
-import { UnderlyingSymbol } from './underlying-symbol';
-/**
- *
- * @export
- * @interface BrokerageSymbolOptionSymbol
- */
-export interface BrokerageSymbolOptionSymbol {
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolOptionSymbol
-     */
-    'id': string;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolOptionSymbol
-     */
-    'ticker': string;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolOptionSymbol
-     */
-    'option_type': BrokerageSymbolOptionSymbolOptionTypeEnum;
-    /**
-     *
-     * @type {number}
-     * @memberof BrokerageSymbolOptionSymbol
-     */
-    'strike_price': number;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolOptionSymbol
-     */
-    'expiration_date': string;
-    /**
-     *
-     * @type {boolean}
-     * @memberof BrokerageSymbolOptionSymbol
-     */
-    'is_mini_option'?: boolean;
-    /**
-     *
-     * @type {UnderlyingSymbol}
-     * @memberof BrokerageSymbolOptionSymbol
-     */
-    'underlying_symbol': UnderlyingSymbol;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolOptionSymbol
-     */
-    'local_id'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolOptionSymbol
-     */
-    'exchange_id'?: string;
-}
-type BrokerageSymbolOptionSymbolOptionTypeEnum = 'CALL' | 'PUT';
-export {};

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

@@ -1,71 +0,0 @@
-import { Currency } from './currency';
-import { Exchange } from './exchange';
-import { SecurityType } from './security-type';
-import { SymbolFigiInstrument } from './symbol-figi-instrument';
-/**
- *
- * @export
- * @interface BrokerageSymbolSymbol
- */
-export interface BrokerageSymbolSymbol {
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolSymbol
-     */
-    'id': string;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolSymbol
-     */
-    'symbol': string;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolSymbol
-     */
-    'raw_symbol': string;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolSymbol
-     */
-    'description'?: string | null;
-    /**
-     *
-     * @type {Currency}
-     * @memberof BrokerageSymbolSymbol
-     */
-    'currency': Currency;
-    /**
-     *
-     * @type {Exchange}
-     * @memberof BrokerageSymbolSymbol
-     */
-    'exchange'?: Exchange;
-    /**
-     *
-     * @type {SecurityType}
-     * @memberof BrokerageSymbolSymbol
-     */
-    'type': SecurityType;
-    /**
-     *
-     * @type {Array<Currency>}
-     * @memberof BrokerageSymbolSymbol
-     */
-    'currencies': Array<Currency>;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbolSymbol
-     */
-    'figi_code'?: string | null;
-    /**
-     *
-     * @type {SymbolFigiInstrument}
-     * @memberof BrokerageSymbolSymbol
-     */
-    'figi_instrument'?: SymbolFigiInstrument | null;
-}

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

@@ -1,47 +0,0 @@
-import { BrokerageAuthorization } from './brokerage-authorization';
-import { BrokerageSymbolOptionSymbol } from './brokerage-symbol-option-symbol';
-import { BrokerageSymbolSymbol } from './brokerage-symbol-symbol';
-/**
- * Brokerage symbol
- * @export
- * @interface BrokerageSymbol
- */
-export interface BrokerageSymbol {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbol
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {BrokerageSymbolSymbol}
-     * @memberof BrokerageSymbol
-     */
-    'symbol'?: BrokerageSymbolSymbol | null;
-    /**
-     *
-     * @type {BrokerageAuthorization}
-     * @memberof BrokerageSymbol
-     */
-    'brokerage_authorization'?: BrokerageAuthorization;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageSymbol
-     */
-    'description'?: string;
-    /**
-     *
-     * @type {boolean}
-     * @memberof BrokerageSymbol
-     */
-    'allows_fractional_units'?: boolean | null;
-    /**
-     *
-     * @type {BrokerageSymbolOptionSymbol}
-     * @memberof BrokerageSymbol
-     */
-    'option_symbol'?: BrokerageSymbolOptionSymbol | null;
-}

package/dist/models/calculated-trade.d.ts

@@ -1,21 +0,0 @@
-import { Trade } from './trade';
-/**
- * Array of trades to make to rebalance portfolio
- * @export
- * @interface CalculatedTrade
- */
-export interface CalculatedTrade {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof CalculatedTrade
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {Array<Trade>}
-     * @memberof CalculatedTrade
-     */
-    'trades'?: Array<Trade>;
-}

package/dist/models/calculated-trade.js

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

package/dist/models/excluded-asset.d.ts

@@ -1,15 +0,0 @@
-import { UniversalSymbol } from './universal-symbol';
-/**
- * An excluded asset in a portfolio group
- * @export
- * @interface ExcludedAsset
- */
-export interface ExcludedAsset {
-    [key: string]: any;
-    /**
-     *
-     * @type {UniversalSymbol}
-     * @memberof ExcludedAsset
-     */
-    'symbol'?: UniversalSymbol;
-}

package/dist/models/excluded-asset.js

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

package/dist/models/jwt.d.ts

@@ -1,14 +0,0 @@
-/**
- * JWT Token. Used to acess resources in private endpoints available only through the Passiv app
- * @export
- * @interface JWT
- */
-export interface JWT {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof JWT
-     */
-    'token'?: string;
-}

package/dist/models/jwt.js

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

package/dist/models/model-asset-class-details.d.ts

@@ -1,22 +0,0 @@
-import { ModelAssetClass } from './model-asset-class';
-import { ModelAssetClassTarget } from './model-asset-class-target';
-/**
- *
- * @export
- * @interface ModelAssetClassDetails
- */
-export interface ModelAssetClassDetails {
-    [key: string]: any;
-    /**
-     *
-     * @type {ModelAssetClass}
-     * @memberof ModelAssetClassDetails
-     */
-    'model_asset_class'?: ModelAssetClass;
-    /**
-     *
-     * @type {Array<ModelAssetClassTarget>}
-     * @memberof ModelAssetClassDetails
-     */
-    'model_asset_class_target'?: Array<ModelAssetClassTarget>;
-}

package/dist/models/model-asset-class-details.js

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

package/dist/models/model-asset-class-target.d.ts

@@ -1,15 +0,0 @@
-import { UniversalSymbol } from './universal-symbol';
-/**
- *
- * @export
- * @interface ModelAssetClassTarget
- */
-export interface ModelAssetClassTarget {
-    [key: string]: any;
-    /**
-     *
-     * @type {UniversalSymbol}
-     * @memberof ModelAssetClassTarget
-     */
-    'symbol'?: UniversalSymbol;
-}

package/dist/models/model-asset-class-target.js

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

package/dist/models/model-asset-class.d.ts

@@ -1,20 +0,0 @@
-/**
- *
- * @export
- * @interface ModelAssetClass
- */
-export interface ModelAssetClass {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof ModelAssetClass
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof ModelAssetClass
-     */
-    'name'?: string;
-}

package/dist/models/model-asset-class.js

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

package/dist/models/model-portfolio-asset-class.d.ts

@@ -1,21 +0,0 @@
-import { ModelAssetClass } from './model-asset-class';
-/**
- *
- * @export
- * @interface ModelPortfolioAssetClass
- */
-export interface ModelPortfolioAssetClass {
-    [key: string]: any;
-    /**
-     *
-     * @type {ModelAssetClass}
-     * @memberof ModelPortfolioAssetClass
-     */
-    'model_asset_class'?: ModelAssetClass;
-    /**
-     *
-     * @type {number}
-     * @memberof ModelPortfolioAssetClass
-     */
-    'percent'?: number;
-}

package/dist/models/model-portfolio-asset-class.js

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

package/dist/models/model-portfolio-details.d.ts

@@ -1,29 +0,0 @@
-import { ModelPortfolio } from './model-portfolio';
-import { ModelPortfolioAssetClass } from './model-portfolio-asset-class';
-import { ModelPortfolioSecurity } from './model-portfolio-security';
-/**
- *
- * @export
- * @interface ModelPortfolioDetails
- */
-export interface ModelPortfolioDetails {
-    [key: string]: any;
-    /**
-     *
-     * @type {ModelPortfolio}
-     * @memberof ModelPortfolioDetails
-     */
-    'model_portfolio'?: ModelPortfolio;
-    /**
-     *
-     * @type {Array<ModelPortfolioSecurity>}
-     * @memberof ModelPortfolioDetails
-     */
-    'model_portfolio_security'?: Array<ModelPortfolioSecurity>;
-    /**
-     *
-     * @type {Array<ModelPortfolioAssetClass>}
-     * @memberof ModelPortfolioDetails
-     */
-    'model_portfolio_asset_class'?: Array<ModelPortfolioAssetClass>;
-}

package/dist/models/model-portfolio-details.js

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

package/dist/models/model-portfolio-security.d.ts

@@ -1,21 +0,0 @@
-import { UniversalSymbol } from './universal-symbol';
-/**
- *
- * @export
- * @interface ModelPortfolioSecurity
- */
-export interface ModelPortfolioSecurity {
-    [key: string]: any;
-    /**
-     *
-     * @type {UniversalSymbol}
-     * @memberof ModelPortfolioSecurity
-     */
-    'symbol'?: UniversalSymbol;
-    /**
-     *
-     * @type {number}
-     * @memberof ModelPortfolioSecurity
-     */
-    'percent'?: number;
-}

package/dist/models/model-portfolio-security.js

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