snaptrade-typescript-sdk 9.0.32 → 9.0.34

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/order-type-strict.d.ts

@@ -3,4 +3,4 @@
  * @export
  * @enum {string}
  */
-export type OrderTypeStrict = 'Limit' | 'Market' | 'StopLimit' | 'StopLoss';
+export type OrderTypeStrict = 'Limit' | 'Market' | 'StopLimit' | 'Stop';

package/dist/models/past-value.d.ts

@@ -6,7 +6,7 @@
 export interface PastValue {
     [key: string]: any;
     /**
-     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
      * @type {string}
      * @memberof PastValue
      */

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/snap-trade-holdings-account-account-id.d.ts

@@ -1,4 +1,3 @@
-import { CashRestriction } from './cash-restriction';
 import { SnapTradeHoldingsAccountAccountIdBalance } from './snap-trade-holdings-account-account-id-balance';
 /**
  * A single brokerage account at a financial institution.
@@ -61,11 +60,11 @@ export interface SnapTradeHoldingsAccountAccountId {
     };
     /**
      * This field is deprecated.
-     * @type {Array<CashRestriction>}
+     * @type {Array<string>}
      * @memberof SnapTradeHoldingsAccountAccountId
      * @deprecated
      */
-    'cash_restrictions'?: Array<CashRestriction>;
+    'cash_restrictions'?: Array<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.
      * @type {string}

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

@@ -37,7 +37,7 @@ export interface StrategyOrderRecord {
      */
     'closed_quantity'?: number;
     /**
-     * Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - StopLoss
+     * Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - Stop
      * @type {string}
      * @memberof StrategyOrderRecord
      */

package/dist/models/sub-period-return-rate.d.ts

@@ -6,13 +6,13 @@
 export interface SubPeriodReturnRate {
     [key: string]: any;
     /**
-     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
      * @type {string}
      * @memberof SubPeriodReturnRate
      */
     'periodStart'?: string;
     /**
-     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
      * @type {string}
      * @memberof SubPeriodReturnRate
      */

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;
+}

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.34",
   "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 {};